Spinnaker C
4.3.0.189
 
Functions
IEnumEntry Access

The functions in this section provide access to entry nodes This includes retrieving the integer value or the symbolic of an entry. More...

Functions

SPINNAKERC_API spinEnumerationEntryGetIntValue (spinNodeHandle hNode, int64_t *pValue)
 Retrieves the integer value of an entry node; note that enumeration entry int and enum values are different - int values defined on camera, enum values found in SpinnakerDefsC.h. More...
 
SPINNAKERC_API spinEnumerationEntryGetEnumValue (spinNodeHandle hNode, size_t *pValue)
 Retrieves the enum value (as an integer) of an entry node; note that enumeraiton entry int and enum values are different - int values defined on camera, enum values found in SpinnakerDefsC.h. More...
 
SPINNAKERC_API spinEnumerationEntryGetSymbolic (spinNodeHandle hNode, char *pBuf, size_t *pBufLen)
 Retrieves the symbolic of an entry node as a c-string. More...
 

Detailed Description

The functions in this section provide access to entry nodes This includes retrieving the integer value or the symbolic of an entry.

Function Documentation

◆ spinEnumerationEntryGetEnumValue()

SPINNAKERC_API spinEnumerationEntryGetEnumValue ( spinNodeHandle  hNode,
size_t *  pValue 
)

Retrieves the enum value (as an integer) of an entry node; note that enumeraiton entry int and enum values are different - int values defined on camera, enum values found in SpinnakerDefsC.h.

See also
spinEnumerationSetEnumValue()
spinError
Parameters
hNodeThe entry node of the enum value to retrieve
pValueThe unsigned integer pointer in which the enum value of the entry is returned
Returns
spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinEnumerationEntryGetIntValue()

SPINNAKERC_API spinEnumerationEntryGetIntValue ( spinNodeHandle  hNode,
int64_t *  pValue 
)

Retrieves the integer value of an entry node; note that enumeration entry int and enum values are different - int values defined on camera, enum values found in SpinnakerDefsC.h.

See also
spinEnumerationSetIntValue()
spinError
Parameters
hNodeThe entry node of the integer value to retrieve
pValueThe integer pointer in which the integer value of the entry is returned
Returns
spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error
Examples
Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Exposure_C.c, ImageEvents_C.c, ImageFormatControl_C.c, LookupTable_C.c, NodeMapCallback_C.c, SaveToVideo_C.c, Sequencer_C.c, and Trigger_C.c.

◆ spinEnumerationEntryGetSymbolic()

SPINNAKERC_API spinEnumerationEntryGetSymbolic ( spinNodeHandle  hNode,
char *  pBuf,
size_t *  pBufLen 
)

Retrieves the symbolic of an entry node as a c-string.

See also
spinError
Parameters
hNodeThe entry node of the symbolic to retrieve
pBufThe c-string character buffer in which the symbolic of the entry node is returned
pBufLenThe unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length
Returns
spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error
Examples
Acquisition_C.c, NodeMapCallback_C.c, and NodeMapInfo_C.c.