InterfaceList Access

The functions in this section provide access to information, objects, and functionality of interface lists. This includes updating, size and interface retrieval, and clearance. More...

Functions
SPINNAKERC_API	spinInterfaceListCreateEmpty (spinInterfaceList *phInterfaceList)
	Creates an empty interface list (interface lists created this way must be destroyed) More...
SPINNAKERC_API	spinInterfaceListDestroy (spinInterfaceList hInterfaceList)
	Destroys an interface list. More...
SPINNAKERC_API	spinInterfaceListGetSize (spinInterfaceList hInterfaceList, size_t *pSize)
	Retrieves the number of interfaces in an interface list. More...
SPINNAKERC_API	spinInterfaceListGet (spinInterfaceList hInterfaceList, size_t index, spinInterface *phInterface)
	Retrieves an interface from an interface list using an index (interfaces retrieved this way must be released) More...
SPINNAKERC_API	spinInterfaceListClear (spinInterfaceList hInterfaceList)
	Clears an interface list. More...

Detailed Description

The functions in this section provide access to information, objects, and functionality of interface lists. This includes updating, size and interface retrieval, and clearance.

Function Documentation

spinInterfaceListClear()

SPINNAKERC_API spinInterfaceListClear

(

spinInterfaceList

hInterfaceList

)

Clears an interface list.

See also

spinError

Parameters

hInterfaceList

The interface list to clear

Returns

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

Examples

Enumeration_C.c, Enumeration_C_QuickSpin.c, and NodeMapInfo_C_QuickSpin.c.

spinInterfaceListCreateEmpty()

SPINNAKERC_API spinInterfaceListCreateEmpty

(

spinInterfaceList *

phInterfaceList

)

Creates an empty interface list (interface lists created this way must be destroyed)

See also

spinError

Parameters

phInterfaceList

The interface list handle pointer in which the empty interface list is returned

Returns

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

Examples

Enumeration_C.c, Enumeration_C_QuickSpin.c, and NodeMapInfo_C_QuickSpin.c.

spinInterfaceListDestroy()

SPINNAKERC_API spinInterfaceListDestroy

(

spinInterfaceList

hInterfaceList

)

Destroys an interface list.

See also

spinError

Parameters

hInterfaceList

The interface list to destroy

Returns

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

Examples

Enumeration_C.c, Enumeration_C_QuickSpin.c, and NodeMapInfo_C_QuickSpin.c.

spinInterfaceListGet()

SPINNAKERC_API spinInterfaceListGet	(	spinInterfaceList	hInterfaceList,
		size_t	index,
		spinInterface *	phInterface
	)

Retrieves an interface from an interface list using an index (interfaces retrieved this way must be released)

See also

spinError

Parameters

hInterfaceList	The interface list of the interface to be retrieved
index	The index of the interface
phInterface	The interface handle pointer in which the interface is returned

Returns

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

Examples

Enumeration_C.c, Enumeration_C_QuickSpin.c, and NodeMapInfo_C_QuickSpin.c.

spinInterfaceListGetSize()

SPINNAKERC_API spinInterfaceListGetSize	(	spinInterfaceList	hInterfaceList,
		size_t *	pSize
	)

Retrieves the number of interfaces in an interface list.

See also

spinError

Parameters

hInterfaceList	The interface list where the interfaces to be counted are
pSize	The unsigned integer pointer in which the number of interfaces is returned

Returns

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

See also

spinError

Examples

Enumeration_C.c, Enumeration_C_QuickSpin.c, and NodeMapInfo_C_QuickSpin.c.