OpcUa Browse List Functions

Functions
cvbres_t	CVOPCBLGetNodeId (CVOPCBROWSERESULT BrowseList, size_t Index, CVOPCNODEID &NodeId)
	Gets the OPCUA NodeId of the selected browse list element. More...
cvbres_t	CVOPCBLResultCount (CVOPCBROWSERESULT BrowseList, size_t &NodeCount)
	Gets the number of elements in a browse list. More...
cvbbool_t	IsCVOPCBrowseList (CVOPCBROWSERESULT BrowseList)
	Tries to check whether the given CVOPCBROWSERESULT handle is a valid object. More...

Detailed Description

Functions to create and access browse list objects (OPCBRLIST) and its attributes.

Function Documentation

CVOPCBLGetNodeId()

cvbres_t CVOPCBLGetNodeId	(	CVOPCBROWSERESULT	BrowseList,
		size_t	Index,
		CVOPCNODEID &	NodeId
	)

Gets the OPCUA NodeId of the selected browse list element.

Attention

Always use initialized variables and initialize unused handles with nullptr.

Parameters

[in]	BrowseList	Browse list object to access.
[in]	Index	Index used to identify items inside a OPCBRLIST.
[out]	NodeId	OPCUA NodeId of the browse list element.

Returns

• #CVC_ERROR (#CVC_E_OK) on success.
• #CVC_ERROR (#CVC_E_WRONGOBJECT) if BrowseList is not a valid object.
• Smaller than zero on error (Use CVOPCGetLastErrorString function for a human readable error description).

CVOPCBLResultCount()

cvbres_t CVOPCBLResultCount	(	CVOPCBROWSERESULT	BrowseList,
		size_t &	NodeCount
	)

Gets the number of elements in a browse list.

Attention

Always use initialized variables and initialize unused handles with nullptr.

Parameters

[in]	BrowseList	Browse list object to access.
[in]	Index	Index used to identify items inside a OPCBRLIST.
[out]	NodeCount	Number of children for selected browse list element.

Returns

• #CVC_ERROR (#CVC_E_OK) on success.
• #CVC_ERROR (#CVC_E_WRONGOBJECT) if BrowseList is not a valid object.
• Smaller than zero on error (Use CVOPCGetLastErrorString function for a human readable error description).

Related Topics:

#OpcBLChildCount

IsCVOPCBrowseList()

cvbbool_t IsCVOPCBrowseList

(

CVOPCBROWSERESULT

BrowseList

)

Tries to check whether the given CVOPCBROWSERESULT handle is a valid object.

Attention

Always initialize unused handles with nullptr.

Parameters

[in]

CVB

BrowseList object to be checked.

Returns

TRUE if it is a valid object, FALSE otherwise.