FB_LicFileRead

FB_LicFileRead 1:

The function block reads a file from the license dongle into a provided buffer (pDestBuff and cbReadLen) via a rising edge at bExecute. The buffer must be large enough for the file, otherwise only the first part of the file is read.

FB_LicFileRead 2: Inputs

VAR_INPUT
    sNetId      : T_AmsNetId;
    nPort       : UINT;
    sFileName   : STRING;
    pDestBuff   : PVOID;
    cbReadLen   : UDINT
    bExecute    : BOOL;
    dwPassCode  : DWORD;
    tTimeout    : TIME       := DEFAULT_ADS_TIMEOUT;
END_VAR

Name

Type

Description

sNetId

T_AmsNetId

AmsNetId (AMS network ID) of the license dongle

  • USB dongle: AmsNetId of the TwinCAT computer. For the local computer an empty string may be specified.
  • EL6070: AmsNetId of the EtherCAT master (see AdsAddr.netId in the InfoData of the EL6070)

nPort

UINT

AMS port of the license dongle

  • USB: ADS port of the ESB device (see ADS port on the ESB device tab of the USB dongle; the default is 16#7100)
  • EL6070: ADS port of the EtherCAT Terminal (see AdsAddr.port in the InfoData of the EL6070)

sFileName

STRING

Name of the file to be read

pDestBuff

PVOID

Buffer address for read

cbReadLen

UDINT

Count of bytes for read

bExecute

BOOL

The function block is enabled by a positive edge at this input.

dwPassCode

DWORD

Passcode for file access

tTimeout

TIME

Time-out period that must not be exceeded when the command is executed.

FB_LicFileRead 3: Outputs

VAR_OUTPUT
    bBusy        : BOOL;
    bError       : BOOL;
    nErrorId     : UDINT;
    cbBytesread  : UDINT;
END_VAR

Name

Type

Description

bBusy

BOOL

When the function block is enabled, this output is set and remains set until a feedback is received.

bError

BOOL

If an error occurs during the transmission of the command, this output is set after the bBusy output is reset.

nErrorId

UDINT

Returns the ADS error number when the bError output is set.

cbBytesRead

UDINT

 

Requirements

Development environment

Target platform

PLC libraries to include

TwinCAT v3.1.4022

PC or CX (x64, x86)

Tc2_Utilties >= 3.3.26.0