FB_NoSQLQueryEvt

Function block for executing NoSQL database queries. A QueryBuilder function block that describes the query is used as the input parameter for the methods.

Syntax

Definition:

FUNCTION BLOCK FB_NoSQLQueryEvt
VAR_INPUT
    sNetID: T_AmsNetID := '';
    tTimeout: TIME := T#5S;
END_VAR
VAR_OUTPUT
    bBusy: BOOL;
    bError: BOOL;
    ipTcResult: Tc3_EventLogger.I_TcMessage 
END_VAR

Inputs

Name	Type	Description
sNetID	T_AmsNetID	AMS network ID of the target device at which the ADS command is directed.
tTimeout	TIME	Indicates the time before the function is cancelled.

Properties

Name	Type	Access	Description
eTraceLevel	TcEventSeverity	Get, Set	Specifies the weighting of the events. Only events with a weighting higher than this value are sent to the TwinCAT system.

Outputs

Name	Type	Description
bBusy	BOOL	TRUE as soon as a method of the function block is active.
bError	BOOL	TRUE when an error occurs.
ipTcResult	Tc3_EventLogger.I_TcMessage	Message interface from the TwinCAT 3 EventLogger, which provides details on the return value.

Methods

Name	Definition location	Description
Execute	Local	Sends the query created by the QueryBuilder function block to the database.
ExecuteDataReturn	Local	Sends the query created by the QueryBuilder function block to the database. An instance of the FB_NoSqlResultEvt function block can be transferred for reading the returned records.

Requirements

Development environment	Target platform	PLC libraries to include
TwinCAT v3.1 Build 4022.20	PC or CX (x86)	Tc3_Database

Further Information