DeleteDirectory

TwinCAT TIA
Local File and directory access Folder

ns=2;s=DEPRAG Smart/Local/FileAndDirectoryAccess/DirectoryAccess/DeleteDirectory

The command deletes the specified directory.

Parameters:

Returns:

Examples:

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

Beckhoff parameter:

    bDirectoryAccessDeleteDirectory
    A boolean variable that can be used to trigger the execution of the DeleteDirectory command.
    OutputDataDirectoryAccessDeleteDirectory
    An instance of "ST_VoidOutputData" into which the return value of the DeleteDirectory method is written.
    hrDirectoryAccessDeleteDirectory
    This can be used to monitor the execution of the command. Error codes have the type "HRESULT".
    fbDirectoryAccess
    An instance of the "FB_DirectoryAccess" function block supplied with the DEPRAG Smart library.
    sFullPath
    A STRING variable containing the full path of the directory.
    ConnectionHandle
    "ConnectionHandle" received when establishing a connection between DEPRAG Smart Server and your OPC UA client.


VAR
     bDirectoryAccessDeleteDirectory      : BOOL;
     OutputDataDirectoryAccessDeleteDirectory   : ST_VoidOutputData;
     hrDirectoryAccessDeleteDirectory     : HRESULT;

     fbDirectoryAccess : FB_DirectoryAccess;
END_VAR

hrDirectoryAccessDeleteDirectory := fbDirectoryAccess.DeleteDirectory(
              bExecute    := bDirectoryAccessDeleteDirectory,   
              ConnectionHandle := depragSmartConnection.ConnectionHandle, 
              sFullPath   := 'C:\Test',
              OutputData   => OutputDataDirectoryAccessDeleteDirectory);
IF hrDirectoryAccessDeleteDirectory <> S_FALSE THEN 
     bDirectoryAccessDeleteDirectory := 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".