✕
✕

CloseXmlDocument

TwinCAT
Local File and directory access XML reader

ns=2;s=DEPRAG Smart/Local/FileAndDirectoryAccess/Xml/CloseXmlDocument

The command closes the XML document and releases the index in the ActiveXMLDocuments list.

Parameters:

    Id
    Unique index to retrieve the XML document in the ActiveXmlDocuments list.

Returns:

    CloseXmlDocument
    A variable of type OpcMethodReturnValueInt32. The Result property contains the command-specific return values.
      Result
      Unique index to retrieve the XML document in the ActiveXmlDocuments list.

Examples:

In addition to the parameters already explained, the following variables must be created / transferred for the implementation in TwinCAT 3:

Beckhoff parameter:

    bXmlCloseXmlDocument
    A boolean variable that can be used to trigger the execution of the CloseXmlDocument command.
    OutputDataXmlCloseXmlDocument
    An instance of the "ST_VoidOutputData" structure into which the return value of the CloseXmlDocument method is written.
    hrXmlCloseXmlDocument
    This can be used to monitor the execution of the command. Error codes have the type "HRESULT".
    fbXml
    An instance of the "FB_Xml" function block supplied with the DEPRAG Smart library.
    nId
    A DINT variable that uniquely identifies the XML document in the ActiveXmlDocuments list.
    ConnectionHandle
    "ConnectionHandle" received when establishing a connection between DEPRAG Smart Server and your OPC UA client. 


VAR
       bXmlCloseXmlDocument   : BOOL;
       OutputDataXmlCloseXmlDocument : ST_XmlDocumentOutputData;
       hrXmlCloseXmlDocument   : HRESULT;

       fbXml        : FB_Xml;
END_VAR

hrXmlCloseXmlDocument := fbXml.CloseXmlDocument(
        bExecute    := bXmlCloseXmlDocument,   
        ConnectionHandle := depragSmartConnection.ConnectionHandle, 
        nId     := 0,
        OutputData   => OutputDataXmlCloseXmlDocument);
IF hrXmlCloseXmlDocument <> S_FALSE THEN 
       bXmlCloseXmlDocument := FALSE;
END_IF

For examples and explanations regarding the calls of nodes via Siemens TIA Portal please refer to the sub-menu "Siemens TIA Portal" in section "Getting Started".