INodeMapHandle2

Interface for accessing module properties. More...

Functions
cvbbool_t	CanNodeMapHandle2 (IMG Image)
	Returns a truth value for the following proposition: The CVB image object supports the INodeMapHandle2 interface. More...
cvbres_t	NMH2GetDescription (IMG Image, const char *ID, char *DescBuffer, size_t &DescBufferSize)
	Retrieves the description about a node map that is specified by an ID. More...
cvbres_t	NMH2GetID (IMG Image, size_t IDIndex, char *IDBuffer, size_t &IDBufferSize)
	Retrieves the ID string of a node map that is specified by an index. More...
cvbres_t	NMH2GetNodeMap (IMG Image, const char *ID, NODEMAP &NodeMap)
	Retrieves the handle of a node map that is specified by an ID. More...
cvbres_t	NMH2GetNum (IMG Image, size_t &NumNodeMaps)
	Returns the number of node maps that a CVB image object is holding. More...

Detailed Description

Interface for accessing module properties.

Some system entities such as cameras, driver software, interface cards, or frame grabber boards offer an ability to access their properties through an object called node map. A node map holds nodes that represent the properties. This collection offers features that are needed to access a node map.

Function Documentation

CanNodeMapHandle2()

cvbbool_t CanNodeMapHandle2

(

IMG

Image

)

Returns a truth value for the following proposition: The CVB image object supports the INodeMapHandle2 interface.

Parameters

[in]

Image

The handle of a target CVB image object.

Returns

TRUE if the image supports the NodeMapHandle2 interface, otherwise FALSE.

NMH2GetDescription()

cvbres_t NMH2GetDescription	(	IMG	Image,
		const char *	ID,
		char *	DescBuffer,
		size_t &	DescBufferSize
	)

Retrieves the description about a node map that is specified by an ID.

To retrieve a description, it is mandatory to know the required size of the buffer that is used to store the description. To get the size of the required buffer size, call this function passing NULL to DescBuffer and passing 0 to DescBufferSize. If the execution is ended up without any error, DescBufferSize will be holding the required buffer size.

Parameters

[in]	Image	The handle of the target CVB image object.
[in]	ID	The index of the target node map.
[in,out]	DescBuffer	The pointer to a buffer that is used to store the description.
[in,out]	DescBufferSize	The size of DescBuffer; the unit is the byte.

Returns

• #CVC_ERROR (#CVC_E_OK): No error.
• Others: An error occurred.

Note

An ID must be the one returned by NMH2GetID.

See also

• NMH2GetID

NMH2GetID()

cvbres_t NMH2GetID	(	IMG	Image,
		size_t	IDIndex,
		char *	IDBuffer,
		size_t &	IDBufferSize
	)

Retrieves the ID string of a node map that is specified by an index.

A node map can be specified by IDIndex. The indices are zero-based and they consist of consecutive integers hence the last index is one smaller than NMH2GetNum returns through NumNodeMaps.

To retrieve an ID string, it is mandatory to know the required size of the buffer that is used to store the ID string. To get the size of the required buffer size, call this function passing NULL to IDBuffer and passing 0 to IDBufferSize. If the execution is ended up without any error, IDBufferSize will be holding the required buffer size.

Parameters

[in]	Image	The handle of a target CVB image object.
[in]	IDIndex	The index of the target node map.
[in,out]	IDBuffer	The pointer to a buffer that is used to store the ID string.
[in,out]	IDBufferSize	The size of IDBuffer; the unit is the byte.

Returns

• #CVC_ERROR (#CVC_E_OK): No error.
• Others: An error occurred.

See also

• NMH2GetNum

NMH2GetNodeMap()

cvbres_t NMH2GetNodeMap	(	IMG	Image,
		const char *	ID,
		NODEMAP &	NodeMap
	)

Retrieves the handle of a node map that is specified by an ID.

Parameters

[in]	Image	The handle of a target CVB image object.
[in]	ID	The ID string of the target node map.
[out]	NodeMap	The handle of the target node map.

Returns

• #CVC_ERROR (#CVC_E_OK): No error.
• Others: An error occurred.

Note

An ID must be the one returned by NMH2GetID.

See also

NMH2GetID

NMH2GetNum()

cvbres_t NMH2GetNum	(	IMG	Image,
		size_t &	NumNodeMaps
	)

Returns the number of node maps that a CVB image object is holding.

Parameters

[in]	Image	The handle of a target CVB image object.
[out]	NumNodeMaps	The number of available node maps.

Returns

• #CVC_ERROR (#CVC_E_OK): No error.
• Others: An error occurred.

Note

The number of available node maps is updated on this function call. The number will not change until the next call is made.