AoHold()

Increment the hold counter for a control

Synopsis:

#include <aoi.h>

int32_t AoHold(const AOICtrl_t *ctrl);

Arguments:

ctrl
A pointer to the AOICtrl_t structure for the AOI control you want to hold.

Library:

libaoi.so

Description:

This function increments the hold counter for a control. If the control was previously not held, and it's a DLL, the DLL is loaded and initialized if necessary. You must hold a control before you attempt to get one of its interfaces, and release it with AoRelease() when you're finished using the interface.

Returns:

0 if successful.

Classification:

QNX Neutrino

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

AOICtrl_t, AoGetInterface(), AoIterateHoldGet(), AoRelease()