✕
✕

ReadAllCellsFromRow

TwinCAT TIA
Local File and directory access Excel

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

The command reads the values of all cells in a row of the specified Excel worksheet in a specified path.

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:

    bExcelReadAllCellsFromRow
    A boolean variable that can be used to trigger the execution of the ReadAllCellsFromRow command.
    OutputDataReadAllCellsFromRow
    An instance of "ST_StringOutputData" to which the return value of the ReadAllCellsFromRow method is written.
    hrExcelReadAllCellsFromRow
    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
     bExcelReadAllCellsFromRow    : BOOL;
     OutputDataReadAllCellsFromRow   : ST_StringOutputData;
     hrExcelReadAllCellsFromRow    : HRESULT;

     fbExcel : FB_Excel;
END_VAR

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