✕
✕

ReadAllUsedCellsFromRow

TwinCAT TIA
Local File and directory access Excel

ns=2;s=DEPRAG Smart/Local/FileAndDirectoryAccess/Excel/ReadAllUsedCellsFromRow

The command reads out the values from the first filled cell to the last filled cell of a row in the specified Excel worksheet in a specified path. If there are empty entries between the first and the last filled cell, they are included in the output.

Parameters:

    FileFullPath
    Path of the file. The file can be either a local file or a file stored on a network drive.
    Separator
    Separator between the read values of the cells.

Returns:

Examples:

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

Beckhoff parameter:

    bExcelReadAllUsedCellsFromRow
    A boolean variable that can be used to trigger the execution of the ReadAllUsedCellsFromRow command.
    OutputDataReadAllUsedCellsFromRow
    An instance of "ST_StringOutputData" to which the return value of the ReadAllUsedCellsFromRow method is written.
    hrExcelReadAllUsedCellsFromRow
    This can be used to monitor the execution of the command. Error codes have the type "HRESULT".
    fbExcel
    An instance of the "FB_Excel" function block supplied with the DEPRAG Smart library.
    sFileFullPath
    A STRING variable containing the full path of the Excel file.
    sWorksheetName
    A STRING variable containing the name of the Excel worksheet.
    nRowNumber
    A DINT variable containing the row index.
    Separator
    A STRING(255) variable containing the separators between the read values of the cells.
    ConnectionHandle
    "ConnectionHandle" received when establishing a connection between DEPRAG Smart Server and your OPC UA client. 


VAR
     bExcelReadAllUsedCellsFromRow   : BOOL;
     OutputDataReadAllUsedCellsFromRow  : ST_StringOutputData;
     hrExcelReadAllUsedCellsFromRow   : HRESULT;

     fbExcel : FB_Excel;
END_VAR

hrExcelReadAllUsedCellsFromRow := fbExcel.ReadAllUsedCellsFromRow(
          bExecute    := bExcelReadAllUsedCellsFromRow,   
          ConnectionHandle := depragSmartConnection.ConnectionHandle, 
          sFileFullPath  := 'C:\Test\TestFile.xlsx',
          sWorksheetName  := 'Testsheet',
          nRowNumber   := 1,
          Separator   := ',',
          OutputData   => OutputDataReadAllUsedCellsFromRow);
IF hrExcelReadAllUsedCellsFromRow <> S_FALSE THEN 
     bExcelReadAllUsedCellsFromRow := 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".