UA Ansi C Server Professional  1.3.1.232
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
UaServerRead

Data Structures

struct  _UaServer_ReadContext
 Holds all data to handle the ReadRequest. More...

Functions

OpcUa_StatusCode UaServer_ReadContext_Create (UaServer_ReadContext **a_ppReadContext)
 This function creates a new ReadContext.
OpcUa_Void UaServer_ReadContext_Delete (UaServer_ReadContext **a_ppReadContext)
 This function deletes the existing ReadContext.
OpcUa_StatusCode UaServer_Providers_ReadComplete (UaServer_ProviderReadContext *a_pReadContext)
 Reads a complete context.
OpcUa_StatusCode UaServer_EndRead (OpcUa_StatusCode a_uStatusCode, UaServer_ReadContext *a_pReadContext)
 Ends to read a context.
OpcUa_StatusCode UaServer_Read (UaServer_ReadContext *a_pReadContext)
 Reads a context.
OpcUa_StatusCode UaServer_BeginRead (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void **a_ppRequest, OpcUa_EncodeableType *a_pRequestType)
 This function begins reading information.
OpcUa_StatusCode UaServer_Read_Internal (OpcUa_BaseNode *a_pNode, UaServer_ReadContext *a_pReadContext, OpcUa_Int32 a_iNodeIndex)
 This function allows the internal read.

Detailed Description

Function Documentation

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

This function begins reading information.

Parameters
a_hEndpointhandle to the endpoint.
a_hContextGeneral context containing information like the session object.
a_ppRequestthe request of the current send information.
a_pRequestTypeThe type of request.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_EndRead ( OpcUa_StatusCode  a_uStatusCode,
UaServer_ReadContext a_pReadContext 
)

Ends to read a context.

Parameters
a_uStatusCodeError code.
a_pReadContextthe needed ReadContext.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_Providers_ReadComplete ( UaServer_ProviderReadContext a_pReadContext)

Reads a complete context.

Parameters
a_pReadContextthe needed ReadContext.
Returns
only good if successful.
OpcUa_StatusCode UaServer_Read ( UaServer_ReadContext a_pReadContext)

Reads a context.

Parameters
a_pReadContextthe needed ReadContext.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_Read_Internal ( OpcUa_BaseNode *  a_pNode,
UaServer_ReadContext a_pReadContext,
OpcUa_Int32  a_iNodeIndex 
)

This function allows the internal read.

Parameters
[in]a_pNodeDESCRIPTION
[in]a_pReadContextDESCRIPTION
[in]a_iNodeIndexDESCRIPTION
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_ReadContext_Create ( UaServer_ReadContext **  a_ppReadContext)

This function creates a new ReadContext.

Parameters
a_ppReadContextthe needed ReadContext.
OpcUa_Void UaServer_ReadContext_Delete ( UaServer_ReadContext **  a_ppReadContext)

This function deletes the existing ReadContext.

Parameters
a_ppReadContextthe needed ReadContext.