UaServerBrowse

Data Structures
struct	_UaServer_BrowseContext
	Holds all data to handle the BrowseRequest. More...
struct	_UaServer_BrowseNextContext
	Holds all data to handle the BrowseNextRequest. More...

Functions
OpcUa_Boolean	UaServer_IsSubReference (OpcUa_Reference *a_pReference, OpcUa_NodeId *a_pBaseReferenceId)
	Is ReferenceType a subreference of BaseReference?
OpcUa_StatusCode	UaServer_BrowseContext_Create (UaServer_BrowseContext **a_ppBrowseContext)
	Create a new browse context.
OpcUa_StatusCode	UaServer_BrowseNextContext_Create (UaServer_BrowseNextContext **a_ppBrowseNextContext)
	Create a new browse next context.
OpcUa_StatusCode	UaServer_EndBrowse (OpcUa_StatusCode a_uStatusCode, UaServer_BrowseContext *a_pBrowseContext)
	Ends up the browsing.
OpcUa_StatusCode	UaServer_EndBrowseNext (OpcUa_StatusCode a_uStatusCode, UaServer_BrowseNextContext *a_pBrowseNextContext)
	Ends up the browsing.
OpcUa_Void	UaServer_BrowseContext_Delete (UaServer_BrowseContext **a_ppBrowseContext)
	Delete the current Browsecontext.
OpcUa_Void	UaServer_BrowseNextContext_Delete (UaServer_BrowseNextContext **a_ppBrowseNextContext)
	Delete the current BrowseNextcontext.
OpcUa_StatusCode	UaServer_Providers_BrowseComplete (UaServer_ProviderBrowseContext *a_pBrowseContext)
	Browse a complete context.
OpcUa_StatusCode	UaServer_Browse_GetProviderList (UaServer_BrowseContext *a_pBrowseContext)
	Get the actual Providerlist.
OpcUa_StatusCode	UaServer_Browse_Internal (OpcUa_BaseNode *a_pNode, UaServer_BrowseContext *a_pBrowseContext, OpcUa_Int32 a_iNodeIndex)
	This function allows the internal browse.
OpcUa_StatusCode	UaServer_Browse (UaServer_BrowseContext *a_pBrowseContext)
	Main logic for browse.
OpcUa_StatusCode	UaServer_BrowseNext (UaServer_BrowseNextContext *a_pBrowseNextContext)
	Main logic for BrowseNext.
OpcUa_StatusCode	UaServer_BeginBrowse (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void **a_ppRequest, OpcUa_EncodeableType *a_pRequestType)
	Start to browse through the addressspace.
OpcUa_StatusCode	UaServer_BeginBrowseNext (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void **a_ppRequest, OpcUa_EncodeableType *a_pRequestType)
	ToDoDoc.

Detailed Description

Function Documentation

OpcUa_StatusCode UaServer_BeginBrowse	(	OpcUa_Endpoint	a_hEndpoint,
		OpcUa_Handle	a_hContext,
		OpcUa_Void **	a_ppRequest,
		OpcUa_EncodeableType *	a_pRequestType
	)

Start to browse through the addressspace.

Parameters

a_hEndpoint	handle to the endpoint.
a_hContext	General context containing information like the session object.
a_ppRequest	the request of the current send information.
a_pRequestType	The type of request.

Returns

the OPC UA Status code.

OpcUa_StatusCode UaServer_BeginBrowseNext	(	OpcUa_Endpoint	a_hEndpoint,
		OpcUa_Handle	a_hContext,
		OpcUa_Void **	a_ppRequest,
		OpcUa_EncodeableType *	a_pRequestType
	)

ToDoDoc.

Parameters

[in]	a_hEndpoint	ToDoDoc
[in]	a_hContext	ToDoDoc
[in]	a_ppRequest	ToDoDoc
[in]	a_pRequestType	ToDoDoc

Returns

ToDoDoc

OpcUa_StatusCode UaServer_Browse

(

UaServer_BrowseContext *

a_pBrowseContext

)

Main logic for browse.

Sublogic goes from here. (internal browse, provider browse)

Parameters

a_pBrowseContext

Browse context for the first browse or the following browse with continuation point.

Returns

the OPC UA Status code.

OpcUa_StatusCode UaServer_Browse_GetProviderList

(

UaServer_BrowseContext *

a_pBrowseContext

)

Get the actual Providerlist.

Parameters

a_pBrowseContext

Browse context for the first browse or the following browse with continuation point.

Returns

the OPC UA Status code.

OpcUa_StatusCode UaServer_Browse_Internal	(	OpcUa_BaseNode *	a_pNode,
		UaServer_BrowseContext *	a_pBrowseContext,
		OpcUa_Int32	a_iNodeIndex
	)

This function allows the internal browse.

Parameters

[in]	a_pNode	ToDoDoc
[in]	a_pBrowseContext	Browse context for the first browse or the following browse with continuation point.
[in]	a_iNodeIndex	the index of the node to browse from the list of the request

Returns

the OPC UA Status code.

OpcUa_StatusCode UaServer_BrowseContext_Create

(

UaServer_BrowseContext **

a_ppBrowseContext

)

Create a new browse context.

Parameters

a_ppBrowseContext

Context for a browse call.

Returns

the OPC UA Status code.

OpcUa_Void UaServer_BrowseContext_Delete

(

UaServer_BrowseContext **

a_ppBrowseContext

)

Delete the current Browsecontext.

Parameters

a_ppBrowseContext

Browse context for the first browse or the following browse with continuation point.

OpcUa_StatusCode UaServer_BrowseNext

(

UaServer_BrowseNextContext *

a_pBrowseNextContext

)

Main logic for BrowseNext.

Sublogic goes from here. (internal browse, provider browse)

Parameters

a_pBrowseNextContext

BrowseNext context

Returns

the OPC UA Status code.

OpcUa_StatusCode UaServer_BrowseNextContext_Create

(

UaServer_BrowseNextContext **

a_ppBrowseNextContext

)

Create a new browse next context.

Parameters

[in]

a_ppBrowseNextContext

Context for a browse next call.

Returns

the OPC UA Status code.

OpcUa_Void UaServer_BrowseNextContext_Delete

(

UaServer_BrowseNextContext **

a_ppBrowseNextContext

)

Delete the current BrowseNextcontext.

Parameters

a_ppBrowseNextContext

BrowseNext context for the first BrowseNext or the following BrowseNext with continuation point.

OpcUa_StatusCode UaServer_EndBrowse	(	OpcUa_StatusCode	a_uStatusCode,
		UaServer_BrowseContext *	a_pBrowseContext
	)

Ends up the browsing.

Parameters

a_uStatusCode	Error code.
a_pBrowseContext	Context of a browse call.

Returns

the OPC UA Status code.

OpcUa_StatusCode UaServer_EndBrowseNext	(	OpcUa_StatusCode	a_uStatusCode,
		UaServer_BrowseNextContext *	a_pBrowseNextContext
	)

Ends up the browsing.

Parameters

a_uStatusCode	Error code.
a_pBrowseNextContext	Context of a browse next call.

Returns

the OPC UA Status code.

OpcUa_Boolean UaServer_IsSubReference	(	OpcUa_Reference *	a_pReference,
		OpcUa_NodeId *	a_pBaseReferenceId
	)

Is ReferenceType a subreference of BaseReference?

Parameters

a_pReference	the Reference
a_pBaseReferenceId	the BaseReference

Returns

True if a subreference, False if not.

OpcUa_StatusCode UaServer_Providers_BrowseComplete

(

UaServer_ProviderBrowseContext *

a_pBrowseContext

)

Browse a complete context.

Parameters

a_pBrowseContext

the needed BrowseContext.

Returns

only good if successful.