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. More...

Functions
SPINNAKERC_API	spinEnumerationGetNumEntries (spinNodeHandle hEnumNode, size_t *pValue)
	Retrieves the number of entries of an enum node. More...

SPINNAKERC_API	spinEnumerationGetEntryByIndex (spinNodeHandle hEnumNode, size_t index, spinNodeHandle *phEntry)
	Retrieves an entry node from an enum node using an index. More...

SPINNAKERC_API	spinEnumerationGetEntryByName (spinNodeHandle hEnumNode, const char pName, spinNodeHandle phEntry)
	Retrieves an entry node from an enum node using the entry's symbolic. More...

SPINNAKERC_API	spinEnumerationGetCurrentEntry (spinNodeHandle hEnumNode, spinNodeHandle *phEntry)
	Retrieves the currently selected entry node from an enum node. More...

SPINNAKERC_API	spinEnumerationReleaseNode (spinNodeHandle hEnumNode, spinNodeHandle hEntry)
	Releases the entry node from the enum node handle. More...

SPINNAKERC_API	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. More...

SPINNAKERC_API	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. More...

Detailed Description

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.

Function Documentation

◆ spinEnumerationGetCurrentEntry()

SPINNAKERC_API 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

Examples: Acquisition_C.c, NodeMapInfo_C.c, and Sequencer_C.c.

◆ spinEnumerationGetEntryByIndex()

SPINNAKERC_API 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

Examples: ChunkData_C.c, and NodeMapCallback_C.c.

◆ spinEnumerationGetEntryByName()

SPINNAKERC_API 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

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.

◆ spinEnumerationGetNumEntries()

SPINNAKERC_API 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

Examples: ChunkData_C.c, and NodeMapCallback_C.c.

◆ spinEnumerationReleaseNode()

SPINNAKERC_API 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; 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

◆ spinEnumerationSetEnumValue()

SPINNAKERC_API 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: spinEnumerationEntryGetEnumValue(); 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

Examples: Exposure_C_Quickspin.c, ImageFormatControl_C_Quickspin.c, and Trigger_C_QuickSpin.c.

◆ spinEnumerationSetIntValue()

SPINNAKERC_API 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: spinEnumerationEntryGetIntValue(); 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

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, LookupTable_C.c, NodeMapCallback_C.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

Functions

Detailed Description

Function Documentation

◆ spinEnumerationGetCurrentEntry()

◆ spinEnumerationGetEntryByIndex()

◆ spinEnumerationGetEntryByName()

◆ spinEnumerationGetNumEntries()

◆ spinEnumerationReleaseNode()

◆ spinEnumerationSetEnumValue()

◆ spinEnumerationSetIntValue()