Teledyne Princeton Instruments PICam 5.x, Programmer'S Manual

Page: 39 / 357

Chapter 4 Identification APIs 39
4.3.1.4 PicamAccessory_GetAvailableAccessoryIDs()
Description
PicamAccessory_GetAvailableAccessoryIDs()
dynamically creates an array of
length N. This array stores accessory IDs for all available accessories.
NOTE:
Accessories that have been disconnected or are currently
open in another process are not available.
NOTE:
Prior to program termination, memory that has been
dynamically allocated to
id_array
must be released by
calling
PicamAccessory_DestroyAccessoryIDs()
.
Syntax
The syntax for
PicamAccessory_GetAvailableAccessoryIDs()
is:
PICAM_API PicamAccessory_GetAvailableAccessoryIDs(
const PicamAccessoryID** id_array,
piint* id_count);
Input Parameters
There are no input parameters associated with
PicamAccessory_GetAvailableAccessoryIDs() .
Output Parameters
Output parameters for PicamAccessory_GetAvailableAccessoryIDs() are:
Related APIs
For additional information, refer to the following related APIs:
• PicamAccessory_DestroyAccessoryIDs() .
id_array:
Pointer to the memory address for the array in which the list of
available accessory IDs is stored.
When there are no available accessory IDs, a null value is returned.
id_count:
The total number of available accessory IDs stored in
id_array.
This equals the length of the array that has been created.
When there are no available accessory IDs, a value of 0 [zero] is
returned.