Group CIEnumEntry¶

Modules > CIEnumEntry

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

Public Functions¶

Type	Name
	spinEnumerationEntryGetEnumValue (spinNodeHandle hNode, size_t * pValue)
	spinEnumerationEntryGetIntValue (spinNodeHandle hNode, int64_t * pValue)
	spinEnumerationEntryGetSymbolic (spinNodeHandle hNode, char * pBuf, size_t * pBufLen)

Public Functions Documentation¶

function spinEnumerationEntryGetEnumValue¶

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: spinError

Parameters:

hNode The entry node of the enum value to retrieve
pValue The 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

function spinEnumerationEntryGetIntValue¶

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()

See also: spinError

Parameters:

hNode The entry node of the integer value to retrieve
pValue The 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

function spinEnumerationEntryGetSymbolic¶

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

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

See also: spinError

Parameters:

hNode The entry node of the symbolic to retrieve
pBuf The c-string character buffer in which the symbolic of the entry node is returned
pBufLen The 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