7.23 UA_Browse

FB-Name UA_Browse
This Function Block is used to navigate through the Address Space. Passing a starting node, the server retuns a list of nodes by references.
The MaxArray size is configured for the controller must be passed as the RequestMaxReferencePerNode in the firmeware service call.
VAR_INPUT
BExecuteBOOLFB performs its task on rising edge on this input.
BConnectionHdlDWORDConnection handle.
EViewDescription UAViewDescriptionOptional: Shall be an empty parameter if NOT browsing a View.
BBrowseDescriptionUABrowseDescription

Starting Node and other information for navigation.

See UABrowseDescription

Hint: This parameter is ignored if the ContinuationPointIn is not 0

BContinuationPointInDWORD

If set to 0 the browse starts with starting node.

If set to ContinuationPointOut it can be used for browse next service.

BTimeoutTIMETime to response.
VAR_OUTPUT
BDoneBOOLFB has completed its task.
BBusyBOOLThe FB is not finished and new output values are to be expected.
BErrorBOOLSignals that an error has occurred within the FB.
BErrorIDDWORDError code.
BBrowseResultCountUINT

The number of entries in the BrowseResult array

BBrowseResultARRAY OF
UAReferenceDescription

List of references and target node information for the node passing the filter criteria in the request

See UAReferenceDescription

Length is vendor-specific (MAX_ELEMENTS_BROWSERESULT). See Constants of Array Lengths
Hint: MaxSize is initialized by a predefined fixed size

BContinuationPointOutDWORDSet when the server was not able to to deliver all results. Can be used to copy it to ContinuationPointIn for browse next service
Notes: -
UA_Browse
BOOLExecuteDoneBOOL
DWORDConnectionHdl BusyBOOL
UAViewDescriptionViewDescription ErrorBOOL
UABrowseDescriptionBrowseDescription ErrorIDDWORD
DWORDContinuationPointIn BrowseResultCountUINT

TIME
Timeout
BrowseResult		ARRAY OF
UAReferenceDescription
ContinuationPointOutDWORD