Group CIEnumeration¶

Modules > CIEnumeration

The functions in this section provide access to enum nodes. This includes retrieving the number of entries, an entry by index or name, retrieving the current entry node, or setting the node using an integer.

Public Functions¶

Type	Name
	spinEnumerationGetCurrentEntry (spinNodeHandle hEnumNode, spinNodeHandle * phEntry)
	spinEnumerationGetEntryByIndex (spinNodeHandle hEnumNode, size_t index, spinNodeHandle * phEntry)
	spinEnumerationGetEntryByName (spinNodeHandle hEnumNode, const char * pName, spinNodeHandle * phEntry)
	spinEnumerationGetNumEntries (spinNodeHandle hEnumNode, size_t * pValue)
	spinEnumerationReleaseNode (spinNodeHandle hEnumNode, spinNodeHandle hEntry)
	spinEnumerationSetEnumValue (spinNodeHandle hEnumNode, size_t value)
	spinEnumerationSetIntValue (spinNodeHandle hEnumNode, int64_t value)

Public Functions Documentation¶

function spinEnumerationGetCurrentEntry¶

spinEnumerationGetCurrentEntry (
    spinNodeHandle hEnumNode,
    spinNodeHandle * phEntry
)

Retrieves the currently selected entry node from an enum node

See also: spinError

Parameters:

hEnumNode The enum node from which the current entry node is retrieved
phEntry The node handle pointer in which the current entry node is returned

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinEnumerationGetEntryByIndex¶

spinEnumerationGetEntryByIndex (
    spinNodeHandle hEnumNode,
    size_t index,
    spinNodeHandle * phEntry
)

Retrieves an entry node from an enum node using an index

See also: spinError

Parameters:

hEnumNode The enum node from which the entry node is retrieved
index The index of the entry node
phEntry The node handle pointer in which the entry node is returned

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinEnumerationGetEntryByName¶

spinEnumerationGetEntryByName (
    spinNodeHandle hEnumNode,
    const char * pName,
    spinNodeHandle * phEntry
)

Retrieves an entry node from an enum node using the entry's symbolic

See also: spinError

Parameters:

hEnumNode The enum node from which the entry node is retrieved
pName The name of the entry node
phEntry The node handle pointer in which the entry node is returned

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinEnumerationGetNumEntries¶

spinEnumerationGetNumEntries (
    spinNodeHandle hEnumNode,
    size_t * pValue
)

Retrieves the number of entries of an enum node

See also: spinError

Parameters:

hEnumNode The enum node where the entries to be counted are
pValue The unsigned integer pointer in which the number of entries is returned

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinEnumerationReleaseNode¶

spinEnumerationReleaseNode (
    spinNodeHandle hEnumNode,
    spinNodeHandle hEntry
)

Releases the entry node from the enum node handle. Make sure node handle is cleaned up properly by setting it to NULL after the node is released If this function is not explicitly called, the handle will be released upon the release of the camera handle.

See also: spinCameraRelease

See also: spinError

Parameters:

hEnumNode The enum node from which the current entry node is retrieved
hEntry The entry node handle to be released

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinEnumerationSetEnumValue¶

spinEnumerationSetEnumValue (
    spinNodeHandle hEnumNode,
    size_t value
)

Sets a new entry using its enum; note that enumeration entry int and enum values are different - int values defined on camera, enum values found in SpinnakerDefsC.h

See also: spinError

Parameters:

hEnumNode The enum node have its entry changed
value The enum value of the entry node to set; this corresponds to its integer value created in the library

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinEnumerationSetIntValue¶

spinEnumerationSetIntValue (
    spinNodeHandle hEnumNode,
    int64_t value
)

Sets a new entry using its integer value retrieved from a call to spinEnumerationEntryGetIntValue(); note that enumeration entry int and enum values are different - int values defined on camera, enum values found in SpinnakerDefsC.h

See also: spinError

Parameters:

hEnumNode The enum node having its entry changed
value The integer value of the entry node to set; this corresponds to the integer value internal to the camera

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error