CopySymbolNameByAddress
![CopySymbolNameByAddress 1:](Images/jpg/13478375435__Web.jpg)
This method returns the complete (ADS) symbol name of a transferred symbol. The method returns the size of the string (including null termination). If the destination buffer is too small, it is emptied by a null termination and returned as length 0.
Syntax
METHOD CopySymbolNameByAddress : UDINT
VAR_INPUT
nData : UDINT; // size of symbol
pData : PVOID; // address of symbol
END_VAR
VAR_IN_OUT CONSTANT
sName : STRING; // target string buffer where the symbol name should be copied to
END_VAR
VAR_INPUT
nName : UDINT; // size in bytes of target string buffer
END_VAR
VAR_OUTPUT
hrErrorCode : HRESULT;
END_VAR
Return value
Name | Type |
---|---|
CopySymbolNameByAddress | UDINT |
Inputs
Name | Type |
---|---|
nData | UDINT |
pData | PVOID |
nName | UDINT |
/
Inputs/Outputs
Name | Type |
---|---|
sName | STRING |
Outputs
Name | Type |
---|---|
hrErrorCode | HRESULT |
Sample call:
nSymbolSize := fbJsonDataType.CopySymbolNameByAddress(nData:=SIZEOF(stValues), pData:=ADR(stValues), sName:=sSymbolName, nName:=SIZEOF(sSymbolName));
Requirements
TwinCAT version | Hardware | Libraries to be integrated |
---|---|---|
TwinCAT 3.1, Build 4024.20 | x86, x64, ARM | Tc3_JsonXml 3.3.15.0 |