LLSymbols
Classes | Typedefs | Enumerations | Functions
LLSymbols.h File Reference
#include "LLSymbolsCommonPublic.h"
#include "MisraC.h"
#include <stddef.h>
#include "LLSymbolsDefs.h"

Go to the source code of this file.

Classes

struct  _symProtServerGDB_TCP_t
 
struct  _LLSymServerAddress
 

Typedefs

typedef enum _LLSymProtocol LLSymProtocol
 
typedef struct _symProtServerGDB_TCP_t symProtServerGDB_TCP_t
 
typedef struct _LLSymServerAddress LLSymServerAddress
 
typedef void * LLSymWorkspaceHandle
 
typedef void * LLSymTagHandle
 
typedef void * LLSymTagMapHandle
 
typedef void * LLSymTypeHandle
 
typedef void * LLSymGroupHandle
 

Enumerations

enum  _LLSymProtocol { symProtGDB_TCP = 0, symProtCommLibs = 1, symProtDirectAccess = 2 }
 

Functions

LLSYMBOLS_API LLSym_Init ()
 It initializes the system. More...
 
LLSYMBOLS_API LLSym_Shutdown ()
 It performs the final shutdown process. More...
 
LLSYMBOLS_API LLSym_IsInitOk ()
 It checks whether the initialization process was right or not. More...
 
LLSYMBOLS_API LLSym_OpenWorkspaceEx (uint8_t plc_area, const LLSymServerAddress *address, const TCHAR *targetComm, LLSymWorkspaceHandle *out_wksHandle)
 It returns an handle object for a new workspace to be opened. More...
 
LLSYMBOLS_API LLSym_OpenWorkspace (uint8_t plc_area, const LLSymServerAddress *address, LLSymWorkspaceHandle *out_wksHandle)
 It returns an handle object for a new workspace to be opened. More...
 
LLSYMBOLS_API LLSym_GetServerVersion (LLSymWorkspaceHandle wksHandle, uint8_t *out_verMajor, uint8_t *out_verMinor, uint8_t *out_verRevision, uint8_t *out_verBuild)
 returns the protocol version supported by symbols server. More...
 
LLSYMBOLS_API LLSym_CloseWorkspace (LLSymWorkspaceHandle wksHandle)
 It closes the workspace represented by the handle given as argument of the function. More...
 
LLSYMBOLS_API LLSym_IsValidWorkspace (LLSymWorkspaceHandle wksHandle)
 It checks whether the workspace represented by the the handle object given as argument of the function is still valid or not. More...
 
LLSYMBOLS_API LLSym_GetSymbolTable (LLSymWorkspaceHandle wksHandle, const TCHAR *symbolTableFileName, bool_t overwrite)
 Get symbol table from server and save it as a local copy. This can be useful for offline symbols browsing (a symbol server with offline connection can be used too) More...
 
LLSYMBOLS_API LLSym_GetGlobalTag (LLSymWorkspaceHandle wksHandle, const TCHAR *symbolName, LLSymTagHandle *out_tagHandle)
 It gets a global tag for a symbol on the workspace represented by the handle object given as argument of the function. More...
 
LLSYMBOLS_API LLSym_CloseTag (LLSymTagHandle tagHandle)
 It closes the global tag represented by the handle object given as argument of the function. If tag is associated to any group also remove from it. More...
 
LLSYMBOLS_API LLSym_GetGlobalTags (LLSymWorkspaceHandle wksHandle, LLSymTagHandle **out_tagList, uint32_t *out_numTags)
 It gets a list of tags on the workspace represented by the handle object given as argument of the function. More...
 
LLSYMBOLS_API LLSym_FreeTagList (LLSymTagHandle *tagList)
 Deallocates a list of tags, obtained with the LLSym_GetGlobalTags function. More...
 
LLSYMBOLS_API LLSym_GetGlobalTagsNum (LLSymWorkspaceHandle wksHandle, uint32_t *out_numTags)
 Gets the number of global tags. More...
 
LLSYMBOLS_API LLSym_FillGlobalTagList (LLSymWorkspaceHandle wksHandle, LLSymTagHandle *tagList, uint32_t numTags)
 Fills a list of global tags. Similar to LLSym_GetGlobalTags(), but does not allocate the resulting tagList array; you need to call LLSym_GetGlobalTagsNum() first and preallocate the array. More...
 
LLSYMBOLS_API LLSym_QueryGlobalTags (LLSymWorkspaceHandle wksHandle, const TCHAR *query, LLSymTagHandle **out_tagList, uint32_t *out_numTags)
 It gets a list of tags on the workspace matching the specified query. More...
 
LLSYMBOLS_API LLSym_QueryGlobalTagsNum (LLSymWorkspaceHandle wksHandle, const TCHAR *query, uint32_t *out_numTags)
 Gets the number of global tags matching the specified query. More...
 
LLSYMBOLS_API LLSym_QueryFillGlobalTagList (LLSymWorkspaceHandle wksHandle, const TCHAR *query, LLSymTagHandle *tagList, uint32_t numTags)
 Fills a list of global tags, according to the query. Similar to LLSym_QueryGlobalTags(), but does not allocate the resulting tagList array; you need to call LLSym_QueryGlobalTagsNum() first and preallocate the array. More...
 
LLSYMBOLS_API LLSym_GetGlobalTagsMap (LLSymWorkspaceHandle wksHandle, LLSymTagMapHandle *out_mapHandle)
 DEPRECATED - Command not implemented. More...
 
LLSYMBOLS_API LLSym_FreeTagMap (LLSymTagMapHandle mapHandle)
 DEPRECATED - Command not implemented. More...
 
LLSYMBOLS_API LLSym_GetTagFromMap (LLSymTagMapHandle mapHandle, const TCHAR *symbolName, LLSymTagHandle *out_tagHandle)
 DEPRECATED - Command not implemented. More...
 
LLSYMBOLS_API LLSym_GetTag (LLSymWorkspaceHandle wksHandle, const TCHAR *symbolName, LLSymTagHandle *out_tagHandle)
 It gets a tag (global or program local variable) for a symbol on the workspace represented by the handle object given as argument of the function. More...
 
LLSYMBOLS_API LLSym_ReadMemory (LLSymWorkspaceHandle wksHandle, llsym_addr_t address, void *out_buf, uint32_t size)
 DEPRECATED - Command not implemented. More...
 
LLSYMBOLS_API LLSym_WriteMemory (LLSymWorkspaceHandle wksHandle, llsym_addr_t address, const void *buf, uint32_t size)
 DEPRECATED - Command not implemented. More...
 
LLSYMBOLS_API LLSym_GetCodeId (LLSymWorkspaceHandle wksHandle, uint32_t *outCodeId, bool_t checkWithTarget, uint16_t index, uint16_t subIndex)
 DEPRECATED - Command not implemented. More...
 
LLSYMBOLS_API LLSym_GetTagAttribute (LLSymTagHandle tagHandle, const TCHAR *attrName, TCHAR *out_buf, uint16_t *bufsize)
 DEPRECATED - It returns textual attributes for the tag given as argument of the function. More...
 
LLSYMBOLS_API LLSym_GetTagName (LLSymTagHandle tagHandle, TCHAR *out_buf, uint16_t *bufsize)
 It returns the name of the global tag represented by the handle object given as argument of the function. More...
 
LLSYMBOLS_API LLSym_GetTagDataType (LLSymTagHandle tagHandle, TCHAR *out_buf, uint16_t *bufsize)
 It returns the type of the variable represented by the handle object given as argument of the function. More...
 
LLSYMBOLS_API LLSym_GetTagDataTypeVar (LLSymTagHandle tagHandle, LLSymTyVar *out_type_var)
 It returns the type of the variable represented by the handle object given as argument of the function. More...
 
LLSYMBOLS_API LLSym_GetTagAddress (LLSymTagHandle tagHandle, llsym_addr_t *out_address)
 It returns the address of the tag given as argument of the function. More...
 
LLSYMBOLS_API LLSym_GetTagAddressBitOffset (LLSymTagHandle tagHandle, llsym_addr_t *out_address, uint32_t *out_bit_offset)
 It returns the pair address/offset at which the tag given as argument of the function is. More...
 
LLSYMBOLS_API LLSym_GetTagArrayAddress (LLSymTagHandle tagHandle, uint32_t idx1, uint32_t idx2, uint32_t idx3, llsym_addr_t *out_address)
 It returns the address of the tag handle given as argument of the function, at the specified set of indexes. Clearly, an array only uses the first index, whereas a matrix can use all of them. If the tag has a base type, it requires no indexes. More...
 
LLSYMBOLS_API LLSym_GetTagArrayAddressBitOffset (LLSymTagHandle tagHandle, uint32_t idx1, uint32_t idx2, uint32_t idx3, llsym_addr_t *out_address, uint32_t *out_bit_offset)
 It returns a pair address/offset of the tag handle given as argument of the function, at the specified set of indexes. Clearly, an array only uses the first index, whereas a matrix can use all of them. If the tag has a base type, it requires no indexes. More...
 
LLSYMBOLS_API LLSym_GetTagDataSize (LLSymTagHandle tagHandle, uint32_t *out_size)
 It returns the size of the data contained into the variable represented by the tag. For arrays, it will return the size of the single element. More...
 
LLSYMBOLS_API LLSym_GetTagDataFullSize (LLSymTagHandle tagHandle, uint32_t *out_size)
 It returns the full size of the data contained into the variable represented by the tag. For arrays and structures, it will return the size of the whole variable. More...
 
LLSYMBOLS_API LLSym_IsTagReadOnly (LLSymTagHandle tagHandle, bool_t *out_isReadOnly)
 It checks whether the global tag represented by the handle object given as argument of the function is read only or not. More...
 
LLSYMBOLS_API LLSym_IsTagBitAddress (LLSymTagHandle tagHandle, bool_t *out_isBitAddress)
 It checks whether the tag given as argument of the function is identified by a bit address or not. More...
 
LLSYMBOLS_API LLSym_GetTagDescr (LLSymTagHandle tagHandle, TCHAR *out_buf, uint16_t *bufsize)
 It returns a string representing the description of the global tag represented by the handle object given as argument of the function. More...
 
LLSYMBOLS_API LLSym_GetTagDims (LLSymTagHandle tagHandle, uint32_t *out_dim1, uint32_t *out_dim2, uint32_t *out_dim3)
 It returns up to 3 valid values for the dimensions of the tag handle given as argument of the function. A base type tag has 0 dimensions, an array has 1 dimnesion and a matrix has up to 3 dimensions. More...
 
LLSYMBOLS_API LLSym_GetTagValue_Ptr (LLSymTagHandle tagHandle, void *out_buf, uint32_t bufsize)
 It returns the value global tag given as argument of the function. More...
 
LLSYMBOLS_API LLSym_SetTagValue_Ptr (LLSymTagHandle tagHandle, const void *buf, uint32_t bufsize)
 It sets the value of the global tag given as argument of the function. More...
 
LLSYMBOLS_API LLSym_GetTagArrayValue_Ptr (LLSymTagHandle tagHandle, uint32_t idx1, uint32_t idx2, uint32_t idx3, void *out_buf, uint32_t bufsize)
 It returns the value of the tag given as argument of the function at the specified set of indexes. Clearly, an array only uses the first index, whereas a matrix can use all of them. If the tag has a base type, it requires no indexes. More...
 
LLSYMBOLS_API LLSym_SetTagArrayValue_Ptr (LLSymTagHandle tagHandle, uint32_t idx1, uint32_t idx2, uint32_t idx3, const void *buf, uint32_t bufsize)
 It sets the value of the tag given as argument of the function at the specified set of indexes. Clearly, an array only uses the first index, whereas a matrix can use all of them. If the tag has a base type, it requires no indexes. More...
 
LLSYMBOLS_API LLSym_GetTagRawValue_Ptr (LLSymTagHandle tagHandle, void *out_buf, uint32_t bufsize)
 It returns a binary blob containing all the values of the tag given as argument of the function. More...
 
LLSYMBOLS_API LLSym_SetTagRawValue_Ptr (LLSymTagHandle tagHandle, const void *buf, uint32_t bufsize)
 It sets the content of the buffer as the full value of the tag given as argument of the function. More...
 
LLSYMBOLS_API LLSym_GetTagValue_VARIANT (LLSymTagHandle tagHandle, VARIANT *out_value)
 It reads a tag value from the target, using a VARIANT. More...
 
LLSYMBOLS_API LLSym_SetTagValue_VARIANT (LLSymTagHandle tagHandle, VARIANT value)
 It writes a tag value from the target, using a VARIANT. More...
 
LLSYMBOLS_API LLSym_GetTagArrayValue_VARIANT (LLSymTagHandle tagHandle, uint32_t idx1, uint32_t idx2, uint32_t idx3, VARIANT *out_value)
 It returns the value of the tag given as argument of the function at the specified set of indexes, with VARIANT. Clearly, an array only uses the first index, whereas a matrix can use all of them. If the tag has a base type, it requires no indexes. More...
 
LLSYMBOLS_API LLSym_SetTagArrayValue_VARIANT (LLSymTagHandle tagHandle, uint32_t idx1, uint32_t idx2, uint32_t idx3, VARIANT value)
 It sets the value of the tag given as argument of the function at the specified set of indexes, with VARIANT. Clearly, an array only uses the first index, whereas a matrix can use all of them. If the tag has a base type, it requires no indexes. More...
 
LLSYMBOLS_API LLSym_GetTagType (LLSymTagHandle tagHandle, LLSymTypeHandle *typeHandle)
 It returns the type handle of the tag given as argument of the function. More...
 
LLSYMBOLS_API LLSym_CloseType (LLSymTypeHandle typeHandle)
 Close a type handle. More...
 
LLSYMBOLS_API LLSym_TypeIsBasic (LLSymTypeHandle typeHandle, bool_t *out_IsBasic)
 It checks whether the type given a argument of the function is basic or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call. More...
 
LLSYMBOLS_API LLSym_TypeIsComplex (LLSymTypeHandle typeHandle, bool_t *out_IsComplex)
 It checks whether the type given a argument of the function is complex or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call. More...
 
LLSYMBOLS_API LLSym_TypeIsString (LLSymTypeHandle typeHandle, bool_t *out_IsString)
 It checks whether the type given a argument of the function is a String or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call. More...
 
LLSYMBOLS_API LLSym_TypeIsArray (LLSymTypeHandle typeHandle, bool_t *out_IsArray)
 It checks whether the type given a argument of the function is an array or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call. More...
 
LLSYMBOLS_API LLSym_TypeIsStruct (LLSymTypeHandle typeHandle, bool_t *out_IsStruct)
 It checks whether the type given a argument of the function is a struct or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call. More...
 
LLSYMBOLS_API LLSym_TypeIsFunctionBlock (LLSymTypeHandle typeHandle, bool_t *out_IsFunctionBlock)
 It checks whether the type given a argument of the function is a function block or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call. More...
 
LLSYMBOLS_API LLSym_TypeIsNumeric (LLSymTypeHandle typeHandle, bool_t *out_IsNumeric)
 It checks whether the type given a argument of the function is numeric or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call. More...
 
LLSYMBOLS_API LLSym_TypeIsSigned (LLSymTypeHandle typeHandle, bool_t *out_IsSigned)
 It checks whether the type given a argument of the function is signed or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call. More...
 
LLSYMBOLS_API LLSym_TypeIsInteger (LLSymTypeHandle typeHandle, bool_t *out_IsInteger)
 It checks whether the type given a argument of the function is integer or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call. More...
 
LLSYMBOLS_API LLSym_TypeGetSize (LLSymTypeHandle typeHandle, uint32_t *out_Size)
 It returns the size of the type represented by the handle given as argument of the function. More...
 
LLSYMBOLS_API LLSym_TypeGetName (LLSymTypeHandle typeHandle, TCHAR *out_buf, uint16_t *bufsize)
 It returns the name of the type represented by the handle given as argument of the function. More...
 
LLSYMBOLS_API LLSym_TypeGetNumChildren (LLSymTypeHandle typeHandle, uint32_t *out_NumChildren)
 It returns the number of children of the type handle given as argument of the function. More...
 
LLSYMBOLS_API LLSym_TypeGetChild (LLSymTypeHandle typeHandle, uint32_t childIndex, LLSymTypeHandle *out_typeChild)
 It returns the child type handle at the index of the parent complex type given as argument of the function. More...
 
LLSYMBOLS_API LLSym_TypeGetChildByName (LLSymTypeHandle typeHandle, const TCHAR *fieldName, LLSymTypeHandle *out_typeChild)
 It returns the child type handle by specifying its fieldName within the parent complex type given as argument of the function. More...
 
LLSYMBOLS_API LLSym_TypeGetChildName (LLSymTypeHandle typeHandle, uint32_t childIndex, TCHAR *out_childName, uint16_t *bufsize)
 It returns the child type name at the index of the parent complex type given as argument of the function. More...
 
LLSYMBOLS_API LLSym_TypeGetArrayNumDimensions (LLSymTypeHandle typeHandle, uint32_t *out_numDimensions)
 It returns the number of dimensions of the type handle given as argument of the function. More...
 
LLSYMBOLS_API LLSym_TypeGetArrayDimension (LLSymTypeHandle typeHandle, uint32_t idx, uint32_t *out_Dimension)
 It returns the size of the dimension at the specified index of the type handle given as argument of the function. More...
 
LLSYMBOLS_API LLSym_TypeGetArrayDimensions (LLSymTypeHandle typeHandle, uint32_t *out_Dimensions, uint8_t bufsize)
 It returns the sizes of all dimensions for array types. More...
 
LLSYMBOLS_API LLSym_TypeGetProperties (LLSymTypeHandle typeHandle, uint32_t *out_Properties)
 It returns as a bitmask the various flags of the request type (see enum LLSymTypeProperty) More...
 
LLSYMBOLS_API LLSym_CreateGroup (LLSymWorkspaceHandle wksHandle, LLSymGroupHandle *out_groupHandle)
 It returns an LLSymGroupHandle handle of the empty group of tags. More...
 
LLSYMBOLS_API LLSym_DeleteGroup (LLSymGroupHandle groupHandle)
 Delete the group of tag specified by groupHandle. Tags of the group must be closed explicitely. More...
 
LLSYMBOLS_API LLSym_AddTagToGroup (LLSymGroupHandle groupHandle, LLSymTagHandle tagHandle)
 Add specified tag to group of tags. More...
 
LLSYMBOLS_API LLSym_RemoveTagFromGroup (LLSymGroupHandle groupHandle, LLSymTagHandle tagHandle)
 Remove specified tag from group of tags. More...
 
LLSYMBOLS_API LLSym_GetGroupInfo (LLSymGroupHandle groupHandle, uint32_t *out_numTags, uint32_t *out_byteSize)
 Get the size of the group. More...
 
LLSYMBOLS_API LLSym_ReadGroup (LLSymGroupHandle groupHandle)
 Refresh the values of all the tags of the group in a row. More...
 
LLSYMBOLS_API LLSym_WriteGroup (LLSymGroupHandle groupHandle)
 Write the values of all the tags of the group in a row. More...
 
LLSYMBOLS_API LLSym_GetTagValueFromGroup_Ptr (LLSymGroupHandle groupHandle, LLSymTagHandle tagHandle, void *data, uint32_t data_size)
 Get tag value from group. More...
 
LLSYMBOLS_API LLSym_SetTagValueIntoGroup_Ptr (LLSymGroupHandle groupHandle, LLSymTagHandle tagHandle, const void *data, uint32_t data_size)
 Set tag value into group. More...
 
LLSYMBOLS_API LLSym_GetTagValueFromGroup_VARIANT (LLSymGroupHandle groupHandle, LLSymTagHandle tagHandle, VARIANT *out_value)
 Get tag basic value from group. More...
 
LLSYMBOLS_API LLSym_SetTagValueIntoGroup_VARIANT (LLSymGroupHandle groupHandle, LLSymTagHandle tagHandle, VARIANT value)
 Set tag basic value into group. More...
 

Typedef Documentation

◆ LLSymGroupHandle

typedef void* LLSymGroupHandle

◆ LLSymProtocol

◆ LLSymServerAddress

◆ LLSymTagHandle

typedef void* LLSymTagHandle

◆ LLSymTagMapHandle

typedef void* LLSymTagMapHandle

◆ LLSymTypeHandle

typedef void* LLSymTypeHandle

◆ LLSymWorkspaceHandle

typedef void* LLSymWorkspaceHandle

◆ symProtServerGDB_TCP_t

Enumeration Type Documentation

◆ _LLSymProtocol

Enumerator
symProtGDB_TCP 

GDB on TCP protocol, using internal native implementation. The LLSymServerAddress::tcp member must be filled

symProtCommLibs 

CommLibs usage (on Windows 32bit platform only). The LLSymServerAddress::commString member must be filled

symProtDirectAccess 

Direct access to a LLSymbolsServer instance. the LLSymServerAddress::serverApi must be filled

Function Documentation

◆ LLSym_AddTagToGroup()

LLSYMBOLS_API LLSym_AddTagToGroup ( LLSymGroupHandle  groupHandle,
LLSymTagHandle  tagHandle 
)

Add specified tag to group of tags.

Parameters
groupHandleLLSymGroupHandle of the selected group
tagHandleLLSymTagHandle of the tag to add to the group
Returns
LLSymResult a return code for this function.

◆ LLSym_CloseTag()

LLSYMBOLS_API LLSym_CloseTag ( LLSymTagHandle  tagHandle)

It closes the global tag represented by the handle object given as argument of the function. If tag is associated to any group also remove from it.

Parameters
tagHandlethe global tag handle object.
Returns
LLSymResult a return code for this function.

◆ LLSym_CloseType()

LLSYMBOLS_API LLSym_CloseType ( LLSymTypeHandle  typeHandle)

Close a type handle.

Parameters
typeHandleThe handle to close.
Returns
LLSymResult a return code for this function.

◆ LLSym_CloseWorkspace()

LLSYMBOLS_API LLSym_CloseWorkspace ( LLSymWorkspaceHandle  wksHandle)

It closes the workspace represented by the handle given as argument of the function.

Parameters
wksHandlethe workspace handle object.
Returns
LLSymResult a return code for this function.

◆ LLSym_CreateGroup()

LLSYMBOLS_API LLSym_CreateGroup ( LLSymWorkspaceHandle  wksHandle,
LLSymGroupHandle out_groupHandle 
)

It returns an LLSymGroupHandle handle of the empty group of tags.

Parameters
wksHandlethe workspace whose belong the group
out_groupHandlean handle that identifies the group of tag
Returns
LLSymResult a return code for this function.

◆ LLSym_DeleteGroup()

LLSYMBOLS_API LLSym_DeleteGroup ( LLSymGroupHandle  groupHandle)

Delete the group of tag specified by groupHandle. Tags of the group must be closed explicitely.

Parameters
groupHandleLLSymGroupHandle of the group to delete
Returns
LLSymResult a return code for this function.

◆ LLSym_FillGlobalTagList()

LLSYMBOLS_API LLSym_FillGlobalTagList ( LLSymWorkspaceHandle  wksHandle,
LLSymTagHandle tagList,
uint32_t  numTags 
)

Fills a list of global tags. Similar to LLSym_GetGlobalTags(), but does not allocate the resulting tagList array; you need to call LLSym_GetGlobalTagsNum() first and preallocate the array.

Parameters
wksHandlethe workspace handle object
tagListarray of LLSymTagHandle that will filled
numTagsnumber of global tags to open
Returns
LLSymResult a result code for this function.

◆ LLSym_FreeTagList()

LLSYMBOLS_API LLSym_FreeTagList ( LLSymTagHandle tagList)

Deallocates a list of tags, obtained with the LLSym_GetGlobalTags function.

Parameters
tagListList of tags to deallocate
Returns
LLSymResult a result code for this function.

◆ LLSym_FreeTagMap()

LLSYMBOLS_API LLSym_FreeTagMap ( LLSymTagMapHandle  mapHandle)

DEPRECATED - Command not implemented.

Parameters
mapHandle
Returns
LLSymResult symResNotImplemented.

◆ LLSym_GetCodeId()

LLSYMBOLS_API LLSym_GetCodeId ( LLSymWorkspaceHandle  wksHandle,
uint32_t *  outCodeId,
bool_t  checkWithTarget,
uint16_t  index,
uint16_t  subIndex 
)

DEPRECATED - Command not implemented.

Parameters
wksHandle
outCodeId
checkWithTarget
index
subIndex
Returns
LLSymResult symResNotImplemented.

◆ LLSym_GetGlobalTag()

LLSYMBOLS_API LLSym_GetGlobalTag ( LLSymWorkspaceHandle  wksHandle,
const TCHAR *  symbolName,
LLSymTagHandle out_tagHandle 
)

It gets a global tag for a symbol on the workspace represented by the handle object given as argument of the function.

Parameters
wksHandlethe workspace handle object.
symbolNamethe symbol name.
out_tagHandlean output parameter to the global tag handle object.
Returns
LLSymResult a return code for this function.

◆ LLSym_GetGlobalTags()

LLSYMBOLS_API LLSym_GetGlobalTags ( LLSymWorkspaceHandle  wksHandle,
LLSymTagHandle **  out_tagList,
uint32_t *  out_numTags 
)

It gets a list of tags on the workspace represented by the handle object given as argument of the function.

Parameters
wksHandlethe workspace handle object.
out_tagListan output list containing the tags just opened.
out_numTagsan output parameter containing the number of tags just opened.
Returns
LLSymResult a result code for this function.

◆ LLSym_GetGlobalTagsMap()

LLSYMBOLS_API LLSym_GetGlobalTagsMap ( LLSymWorkspaceHandle  wksHandle,
LLSymTagMapHandle out_mapHandle 
)

DEPRECATED - Command not implemented.

Parameters
wksHandle
out_mapHandle
Returns
LLSymResult symResNotImplemented.

◆ LLSym_GetGlobalTagsNum()

LLSYMBOLS_API LLSym_GetGlobalTagsNum ( LLSymWorkspaceHandle  wksHandle,
uint32_t *  out_numTags 
)

Gets the number of global tags.

Parameters
wksHandlethe workspace handle object
out_numTagsan output parameter containing the number of tags just opened.
Returns
LLSymResult a result code for this function.

◆ LLSym_GetGroupInfo()

LLSYMBOLS_API LLSym_GetGroupInfo ( LLSymGroupHandle  groupHandle,
uint32_t *  out_numTags,
uint32_t *  out_byteSize 
)

Get the size of the group.

Parameters
groupHandleLLSymGroupHandle of the selected group
out_numTagsnumber of tags in the group
out_byteSizetotal size in bytes of the tag values data transferred with LLSym_ReadGroup or LLSym_WriteGroup
Returns
LLSymResult a return code for this function.

◆ LLSym_GetServerVersion()

LLSYMBOLS_API LLSym_GetServerVersion ( LLSymWorkspaceHandle  wksHandle,
uint8_t *  out_verMajor,
uint8_t *  out_verMinor,
uint8_t *  out_verRevision,
uint8_t *  out_verBuild 
)

returns the protocol version supported by symbols server.

Parameters
wksHandlethe workspace handle object.
out_verMajormajor version of the symbols server
out_verMinorminor version of the symbols server
out_verRevisionrevision version of the symbols server
out_verBuildbuild version of the symbols server
Returns
LLSYMBOLS_API a return code for this function.

◆ LLSym_GetSymbolTable()

LLSYMBOLS_API LLSym_GetSymbolTable ( LLSymWorkspaceHandle  wksHandle,
const TCHAR *  symbolTableFileName,
bool_t  overwrite 
)

Get symbol table from server and save it as a local copy. This can be useful for offline symbols browsing (a symbol server with offline connection can be used too)

Parameters
wksHandlethe workspace handle object.
symbolTableFileNamethe file name in which the symbol table will be stored
overwriteif specified overwrite file if exists
Returns
LLSYMBOLS_API a return code for this function.

◆ LLSym_GetTag()

LLSYMBOLS_API LLSym_GetTag ( LLSymWorkspaceHandle  wksHandle,
const TCHAR *  symbolName,
LLSymTagHandle out_tagHandle 
)

It gets a tag (global or program local variable) for a symbol on the workspace represented by the handle object given as argument of the function.

Parameters
wksHandlethe workspace handle object.
symbolNamethe symbol name full path. es "programName.localSymbolName" or "globalSymbolName"
out_tagHandlean output parameter to the global tag handle object.
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagAddress()

LLSYMBOLS_API LLSym_GetTagAddress ( LLSymTagHandle  tagHandle,
llsym_addr_t out_address 
)

It returns the address of the tag given as argument of the function.

Parameters
tagHandlethe global tag handle.
out_addressan output parameter containing the address.
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagAddressBitOffset()

LLSYMBOLS_API LLSym_GetTagAddressBitOffset ( LLSymTagHandle  tagHandle,
llsym_addr_t out_address,
uint32_t *  out_bit_offset 
)

It returns the pair address/offset at which the tag given as argument of the function is.

Parameters
tagHandlethe global tag handle.
out_addressan output parameter containing the address.
out_bit_offsetan output parameter containing the offset.
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagArrayAddress()

LLSYMBOLS_API LLSym_GetTagArrayAddress ( LLSymTagHandle  tagHandle,
uint32_t  idx1,
uint32_t  idx2,
uint32_t  idx3,
llsym_addr_t out_address 
)

It returns the address of the tag handle given as argument of the function, at the specified set of indexes. Clearly, an array only uses the first index, whereas a matrix can use all of them. If the tag has a base type, it requires no indexes.

Parameters
tagHandlethe global tag handle object.
idx1first dimension parameter.
idx2second dimension parameter.
idx3third dimension parameter.
out_addressan output parameter containing the address.
Returns
LLSymResult a return value for this function.

◆ LLSym_GetTagArrayAddressBitOffset()

LLSYMBOLS_API LLSym_GetTagArrayAddressBitOffset ( LLSymTagHandle  tagHandle,
uint32_t  idx1,
uint32_t  idx2,
uint32_t  idx3,
llsym_addr_t out_address,
uint32_t *  out_bit_offset 
)

It returns a pair address/offset of the tag handle given as argument of the function, at the specified set of indexes. Clearly, an array only uses the first index, whereas a matrix can use all of them. If the tag has a base type, it requires no indexes.

Parameters
tagHandlethe global tag handle object.
idx1first dimension parameter.
idx2second dimension parameter.
idx3third dimension parameter.
out_addressan output parameter containing the address.
out_bit_offsetan output parameter containing the offset.
Returns
LLSymResult a return value for this function.

◆ LLSym_GetTagArrayValue_Ptr()

LLSYMBOLS_API LLSym_GetTagArrayValue_Ptr ( LLSymTagHandle  tagHandle,
uint32_t  idx1,
uint32_t  idx2,
uint32_t  idx3,
void *  out_buf,
uint32_t  bufsize 
)

It returns the value of the tag given as argument of the function at the specified set of indexes. Clearly, an array only uses the first index, whereas a matrix can use all of them. If the tag has a base type, it requires no indexes.

Parameters
tagHandlethe global tag handle.
idx1the first index.
idx2the second index.
idx3the third index.
out_bufan output buffer containing the value of the tag.
bufsizethe size of the buffer.
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagArrayValue_VARIANT()

LLSYMBOLS_API LLSym_GetTagArrayValue_VARIANT ( LLSymTagHandle  tagHandle,
uint32_t  idx1,
uint32_t  idx2,
uint32_t  idx3,
VARIANT *  out_value 
)

It returns the value of the tag given as argument of the function at the specified set of indexes, with VARIANT. Clearly, an array only uses the first index, whereas a matrix can use all of them. If the tag has a base type, it requires no indexes.

Parameters
tagHandlethe global tag handle.
idx1the first index.
idx2the second index.
idx3the third index.
out_valuean output parameter containing the tag value.
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagAttribute()

LLSYMBOLS_API LLSym_GetTagAttribute ( LLSymTagHandle  tagHandle,
const TCHAR *  attrName,
TCHAR *  out_buf,
uint16_t *  bufsize 
)

DEPRECATED - It returns textual attributes for the tag given as argument of the function.

Parameters
tagHandlethe global tag handle.
attrNamethe name of the attribute to be got.
out_bufan output buffer containing the attribute value.
bufsizethe size of the output buffer.
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagDataFullSize()

LLSYMBOLS_API LLSym_GetTagDataFullSize ( LLSymTagHandle  tagHandle,
uint32_t *  out_size 
)

It returns the full size of the data contained into the variable represented by the tag. For arrays and structures, it will return the size of the whole variable.

Parameters
tagHandlethe global tag handle.
out_sizean output parameter containing the full size value.
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagDataSize()

LLSYMBOLS_API LLSym_GetTagDataSize ( LLSymTagHandle  tagHandle,
uint32_t *  out_size 
)

It returns the size of the data contained into the variable represented by the tag. For arrays, it will return the size of the single element.

Parameters
tagHandlethe global tag handle.
out_sizean output parameter containing the size value.
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagDataType()

LLSYMBOLS_API LLSym_GetTagDataType ( LLSymTagHandle  tagHandle,
TCHAR *  out_buf,
uint16_t *  bufsize 
)

It returns the type of the variable represented by the handle object given as argument of the function.

Parameters
tagHandlethe global tag handle.
out_bufan output buffer containing the data type.
bufsizethe size of the output buffer.
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagDataTypeVar()

LLSYMBOLS_API LLSym_GetTagDataTypeVar ( LLSymTagHandle  tagHandle,
LLSymTyVar out_type_var 
)

It returns the type of the variable represented by the handle object given as argument of the function.

Parameters
tagHandlethe global tag handle.
out_type_varthe returned data type
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagDescr()

LLSYMBOLS_API LLSym_GetTagDescr ( LLSymTagHandle  tagHandle,
TCHAR *  out_buf,
uint16_t *  bufsize 
)

It returns a string representing the description of the global tag represented by the handle object given as argument of the function.

Parameters
tagHandlethe handle object representing the global tag.
out_bufan output buffer containing the description of the tag.
bufsizethe size of the buffer.
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagDims()

LLSYMBOLS_API LLSym_GetTagDims ( LLSymTagHandle  tagHandle,
uint32_t *  out_dim1,
uint32_t *  out_dim2,
uint32_t *  out_dim3 
)

It returns up to 3 valid values for the dimensions of the tag handle given as argument of the function. A base type tag has 0 dimensions, an array has 1 dimnesion and a matrix has up to 3 dimensions.

Parameters
tagHandlethe global tag handle.
out_dim1the first output parameter for arrays or matrices.
out_dim2the second output parameter for matrices.
out_dim3the third output parameter for matrices.
Returns
LLSymResult a return value for this function.

◆ LLSym_GetTagFromMap()

LLSYMBOLS_API LLSym_GetTagFromMap ( LLSymTagMapHandle  mapHandle,
const TCHAR *  symbolName,
LLSymTagHandle out_tagHandle 
)

DEPRECATED - Command not implemented.

Parameters
mapHandle
symbolName
out_tagHandle
Returns
LLSymResult symResNotImplemented.

◆ LLSym_GetTagName()

LLSYMBOLS_API LLSym_GetTagName ( LLSymTagHandle  tagHandle,
TCHAR *  out_buf,
uint16_t *  bufsize 
)

It returns the name of the global tag represented by the handle object given as argument of the function.

Parameters
tagHandlethe global tag handle.
out_bufan output buffer containing the tag name.
bufsizethe size of the output buffer. If it is too small, symResInvalidBuffer is returned, and this will contain the required number of chars; on success, number of chars written.
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagRawValue_Ptr()

LLSYMBOLS_API LLSym_GetTagRawValue_Ptr ( LLSymTagHandle  tagHandle,
void *  out_buf,
uint32_t  bufsize 
)

It returns a binary blob containing all the values of the tag given as argument of the function.

Parameters
tagHandlethe global tag handle.
out_bufthe ouput buffer containing the binary blob.
bufsizethe size of the buffer; can be greater than the full data size of the tag (in this case the last part will not be written)
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagType()

LLSYMBOLS_API LLSym_GetTagType ( LLSymTagHandle  tagHandle,
LLSymTypeHandle out_typeHandle 
)

It returns the type handle of the tag given as argument of the function.

Parameters
tagHandlethe handle representing the tag.
out_typeHandlean output parameter containing the type handle.
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagValue_Ptr()

LLSYMBOLS_API LLSym_GetTagValue_Ptr ( LLSymTagHandle  tagHandle,
void *  out_buf,
uint32_t  bufsize 
)

It returns the value global tag given as argument of the function.

Parameters
tagHandlethe global tag handle.
out_bufan output parameter containing the value just read.
bufsizethe size of the buffer; can be greater than the data size of the tag (in this case the last part will not be written)
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagValue_VARIANT()

LLSYMBOLS_API LLSym_GetTagValue_VARIANT ( LLSymTagHandle  tagHandle,
VARIANT *  out_value 
)

It reads a tag value from the target, using a VARIANT.

Parameters
tagHandlethe global tag to be read.
out_valuean output parameter containing the value.
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagValueFromGroup_Ptr()

LLSYMBOLS_API LLSym_GetTagValueFromGroup_Ptr ( LLSymGroupHandle  groupHandle,
LLSymTagHandle  tagHandle,
void *  data_out,
uint32_t  data_size 
)

Get tag value from group.

Parameters
groupHandleLLSymGroupHandle of the specified group
tagHandleLLSymTagHandle of the specified tag
data_outbuffer in which to store the value of the tag
data_sizesize of the buffer
Returns
LLSymResult a return code for this function.

◆ LLSym_GetTagValueFromGroup_VARIANT()

LLSYMBOLS_API LLSym_GetTagValueFromGroup_VARIANT ( LLSymGroupHandle  groupHandle,
LLSymTagHandle  tagHandle,
VARIANT *  out_value 
)

Get tag basic value from group.

Parameters
groupHandleLLSymGroupHandle of the specified group
tagHandleLLSymTagHandle of the specified tag
out_valuevalue of the tag read from the group
Returns
LLSymResult a return code for this function.

◆ LLSym_Init()

LLSYMBOLS_API LLSym_Init ( )

It initializes the system.

Returns
LLSymResult a return code for this function.

◆ LLSym_IsInitOk()

LLSYMBOLS_API LLSym_IsInitOk ( )

It checks whether the initialization process was right or not.

Returns
LLSymResult a return code for this function.

◆ LLSym_IsTagBitAddress()

LLSYMBOLS_API LLSym_IsTagBitAddress ( LLSymTagHandle  tagHandle,
bool_t *  out_isBitAddress 
)

It checks whether the tag given as argument of the function is identified by a bit address or not.

Parameters
tagHandlethe global tag handle object.
out_isBitAddressan output parameter with the result of the check.
Returns
LLSymResult a return code for this function.

◆ LLSym_IsTagReadOnly()

LLSYMBOLS_API LLSym_IsTagReadOnly ( LLSymTagHandle  tagHandle,
bool_t *  out_isReadOnly 
)

It checks whether the global tag represented by the handle object given as argument of the function is read only or not.

Parameters
tagHandlethe global tag handle.
out_isReadOnlyan output parameter containing the value binded to the check.
Returns
LLSymResult a return code for this function.

◆ LLSym_IsValidWorkspace()

LLSYMBOLS_API LLSym_IsValidWorkspace ( LLSymWorkspaceHandle  wksHandle)

It checks whether the workspace represented by the the handle object given as argument of the function is still valid or not.

Parameters
wksHandlethe workspace handle object.
Returns
LLSymResult a return code for this function.

◆ LLSym_OpenWorkspace()

LLSYMBOLS_API LLSym_OpenWorkspace ( uint8_t  plcArea,
const LLSymServerAddress address,
LLSymWorkspaceHandle out_wksHandle 
)

It returns an handle object for a new workspace to be opened.

Parameters
plcAreathe index of the runtime you want to access. Tipically, it is set to 0.
addressthe IP address of the target.
out_wksHandlean output parameter to the workspace handle.
Returns
LLSymResult a return code for this function. IMPORTANT: if the client version is greater than the server version, the operation succeeds and the symResOkServerNotFullSupport value is returned; this should not be handled as an "error".

◆ LLSym_OpenWorkspaceEx()

LLSYMBOLS_API LLSym_OpenWorkspaceEx ( uint8_t  plcArea,
const LLSymServerAddress address,
const TCHAR *  targetComm,
LLSymWorkspaceHandle out_wksHandle 
)

It returns an handle object for a new workspace to be opened.

Parameters
plcAreathe index of the runtime you want to access. Tipically, it is set to 0.
addresssymbols server address. If NULL, server is automatically instantiaded depending on targetComm string specified
targetCommstring. A) WinCommLibs string es: Modbus:247,1000,M::COM:2,38400,E,8,1,H,B B) GDB_TCP string es: 127.0.0.1:5000,1000 (ip:port,timeout)
  • if address param is NULL and targetComm is of type A: communication with remote target (A) is established. Symbols are read from remote target (A)
  • if address param is NULL and targetComm is of type B: connection to remote symbols server (B) is established. Symbols are read from symbols server (B)
  • if address param is !NULL and targetComm is of type A: connection to specified symbols server is established. Target comm is managed by symbols server to read remote target symbols (A)
  • if address param is !NULL and targetComm is of type B: connection to specified symbols server is established. Target comm is managed by symbols server to read remote target symbols (B)
  • if address param is !NULL and targetComm is NULL: connection to specified symbols server is established. Symbols are read from symbols server
out_wksHandlean output parameter to the workspace handle.
Returns
LLSymResult a return code for this function. IMPORTANT: if the client version is greater than the server version, the operation succeeds and the symResOkServerNotFullSupport value is returned; this should not be handled as an "error".

◆ LLSym_QueryFillGlobalTagList()

LLSYMBOLS_API LLSym_QueryFillGlobalTagList ( LLSymWorkspaceHandle  wksHandle,
const TCHAR *  query,
LLSymTagHandle tagList,
uint32_t  numTags 
)

Fills a list of global tags, according to the query. Similar to LLSym_QueryGlobalTags(), but does not allocate the resulting tagList array; you need to call LLSym_QueryGlobalTagsNum() first and preallocate the array.

Parameters
wksHandlethe workspace handle object
queryis the text of the query
tagListarray of LLSymTagHandle that will filled
numTagsnumber of global tags to open
Returns
LLSymResult a result code for this function.

◆ LLSym_QueryGlobalTags()

LLSYMBOLS_API LLSym_QueryGlobalTags ( LLSymWorkspaceHandle  wksHandle,
const TCHAR *  query,
LLSymTagHandle **  out_tagList,
uint32_t *  out_numTags 
)

It gets a list of tags on the workspace matching the specified query.

Parameters
wksHandlethe workspace handle object.
queryis the text of the query
out_tagListan output list containing the tags just opened.
out_numTagsan output parameter containing the number of tags just opened.
Returns
LLSymResult a result code for this function.

◆ LLSym_QueryGlobalTagsNum()

LLSYMBOLS_API LLSym_QueryGlobalTagsNum ( LLSymWorkspaceHandle  wksHandle,
const TCHAR *  query,
uint32_t *  out_numTags 
)

Gets the number of global tags matching the specified query.

Parameters
wksHandlethe workspace handle object
queryis the text of the query; can be a full tag name, or can contain wildcards in the following forms: NAME NAME NAME
out_numTagsan output parameter containing the number of tags just opened.
Returns
LLSymResult a result code for this function.

◆ LLSym_ReadGroup()

LLSYMBOLS_API LLSym_ReadGroup ( LLSymGroupHandle  groupHandle)

Refresh the values of all the tags of the group in a row.

Parameters
groupHandleLLSymGroupHandle of the selected group
Returns
LLSymResult a return code for this function.

◆ LLSym_ReadMemory()

LLSYMBOLS_API LLSym_ReadMemory ( LLSymWorkspaceHandle  wksHandle,
llsym_addr_t  address,
void *  out_buf,
uint32_t  size 
)

DEPRECATED - Command not implemented.

Parameters
wksHandle
address
out_buf
size
Returns
LLSymResult symResNotImplemented.

◆ LLSym_RemoveTagFromGroup()

LLSYMBOLS_API LLSym_RemoveTagFromGroup ( LLSymGroupHandle  groupHandle,
LLSymTagHandle  tagHandle 
)

Remove specified tag from group of tags.

Parameters
groupHandleLLSymGroupHandle of the selected group
tagHandleLLSymTagHandle of the tag to remove from the group
Returns
LLSymResult a return code for this function.

◆ LLSym_SetTagArrayValue_Ptr()

LLSYMBOLS_API LLSym_SetTagArrayValue_Ptr ( LLSymTagHandle  tagHandle,
uint32_t  idx1,
uint32_t  idx2,
uint32_t  idx3,
const void *  buf,
uint32_t  bufsize 
)

It sets the value of the tag given as argument of the function at the specified set of indexes. Clearly, an array only uses the first index, whereas a matrix can use all of them. If the tag has a base type, it requires no indexes.

Parameters
tagHandlethe global tag handle.
idx1the first index.
idx2the second index.
idx3the third index.
bufan output buffer containing the value of the tag.
bufsizethe size of the buffer.
Returns
LLSymResult a return code for this function.

◆ LLSym_SetTagArrayValue_VARIANT()

LLSYMBOLS_API LLSym_SetTagArrayValue_VARIANT ( LLSymTagHandle  tagHandle,
uint32_t  idx1,
uint32_t  idx2,
uint32_t  idx3,
VARIANT  value 
)

It sets the value of the tag given as argument of the function at the specified set of indexes, with VARIANT. Clearly, an array only uses the first index, whereas a matrix can use all of them. If the tag has a base type, it requires no indexes.

Parameters
tagHandlethe global tag handle.
idx1the first index.
idx2the second index.
idx3the third index.
valuethe value to be set.
Returns
LLSymResult a return code for this function.

◆ LLSym_SetTagRawValue_Ptr()

LLSYMBOLS_API LLSym_SetTagRawValue_Ptr ( LLSymTagHandle  tagHandle,
const void *  buff,
uint32_t  bufsize 
)

It sets the content of the buffer as the full value of the tag given as argument of the function.

Parameters
tagHandlethe global tag handle.
buffthe buffer containing the full value.
bufsizethe size of the buffer; can be smaller than the full data size of the tag (partial write)
Returns
LLSymResult a return code for this function.

◆ LLSym_SetTagValue_Ptr()

LLSYMBOLS_API LLSym_SetTagValue_Ptr ( LLSymTagHandle  tagHandle,
const void *  buf,
uint32_t  bufsize 
)

It sets the value of the global tag given as argument of the function.

Parameters
tagHandlethe global tag handle.
bufthe buffer containing the value to be set.
bufsizethe size of the buffer; for strings, can be smaller than the maximum string length of the tag, otherwise must match exactly the data size of the tag
Returns
LLSymResult a return code for this function.

◆ LLSym_SetTagValue_VARIANT()

LLSYMBOLS_API LLSym_SetTagValue_VARIANT ( LLSymTagHandle  tagHandle,
VARIANT  value 
)

It writes a tag value from the target, using a VARIANT.

Parameters
tagHandlethe global tag to be set.
valuethe value to be set to the tag.
Returns
LLSymResult a return code for this function.

◆ LLSym_SetTagValueIntoGroup_Ptr()

LLSYMBOLS_API LLSym_SetTagValueIntoGroup_Ptr ( LLSymGroupHandle  groupHandle,
LLSymTagHandle  tagHandle,
const void *  data,
uint32_t  data_size 
)

Set tag value into group.

Parameters
groupHandleLLSymGroupHandle of the selected group
tagHandleLLSymTagHandle of the specified tag
databuffer with the value of the tag to store in the group
data_sizesize of the buffer
Returns
LLSymResult a return code for this function.

◆ LLSym_SetTagValueIntoGroup_VARIANT()

LLSYMBOLS_API LLSym_SetTagValueIntoGroup_VARIANT ( LLSymGroupHandle  groupHandle,
LLSymTagHandle  tagHandle,
VARIANT  value 
)

Set tag basic value into group.

Parameters
groupHandleLLSymGroupHandle of the selected group
tagHandleLLSymTagHandle of the specified tag
valuevalue of the tag to store in the group
Returns
LLSymResult a return code for this function.

◆ LLSym_Shutdown()

LLSYMBOLS_API LLSym_Shutdown ( )

It performs the final shutdown process.

Returns
LLSymResult a return code for this function.

◆ LLSym_TypeGetArrayDimension()

LLSYMBOLS_API LLSym_TypeGetArrayDimension ( LLSymTypeHandle  typeHandle,
uint32_t  idx,
uint32_t *  out_Dimension 
)

It returns the size of the dimension at the specified index of the type handle given as argument of the function.

Parameters
typeHandlethe type handle object.
idxthe index of the dimension to
out_Dimensionan output parameter containing the size of the requested dimension.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeGetArrayDimensions()

LLSYMBOLS_API LLSym_TypeGetArrayDimensions ( LLSymTypeHandle  typeHandle,
uint32_t *  out_Dimensions,
uint8_t  bufsize 
)

It returns the sizes of all dimensions for array types.

Parameters
typeHandlethe type handle object.
out_Dimensionsan output parameter containing an array, will be populated by the sizes of the dimensions.
bufsizesize of the out_Dimensions parameter (in number of elements)
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeGetArrayNumDimensions()

LLSYMBOLS_API LLSym_TypeGetArrayNumDimensions ( LLSymTypeHandle  typeHandle,
uint32_t *  out_numDimensions 
)

It returns the number of dimensions of the type handle given as argument of the function.

Parameters
typeHandlethe type handle object.
out_numDimensionsan output parameter containing the number of dimensions.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeGetChild()

LLSYMBOLS_API LLSym_TypeGetChild ( LLSymTypeHandle  typeHandle,
uint32_t  childIndex,
LLSymTypeHandle out_typeChild 
)

It returns the child type handle at the index of the parent complex type given as argument of the function.

Parameters
typeHandlethe parent complex type handle.
childIndexthe index of the child type.
out_typeChildthe handle of the child type.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeGetChildByName()

LLSYMBOLS_API LLSym_TypeGetChildByName ( LLSymTypeHandle  typeHandle,
const TCHAR *  fieldName,
LLSymTypeHandle out_typeChild 
)

It returns the child type handle by specifying its fieldName within the parent complex type given as argument of the function.

Parameters
typeHandlethe parent complex type handle.
fieldNamethe name of the child field.
out_typeChildan output parameter containing the handle of the child type.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeGetChildName()

LLSYMBOLS_API LLSym_TypeGetChildName ( LLSymTypeHandle  typeHandle,
uint32_t  childIndex,
TCHAR *  out_childName,
uint16_t *  bufsize 
)

It returns the child type name at the index of the parent complex type given as argument of the function.

Parameters
typeHandlethe parent complex type handle.
childIndexthe index of the child type.
out_childNamean output buffer containing the name of the child type.
bufsizethe size of the buffer.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeGetName()

LLSYMBOLS_API LLSym_TypeGetName ( LLSymTypeHandle  typeHandle,
TCHAR *  out_buf,
uint16_t *  bufsize 
)

It returns the name of the type represented by the handle given as argument of the function.

Parameters
typeHandlethe handle representing the type.
out_bufan output buffer containing the name.
bufsizethe size of the buffer.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeGetNumChildren()

LLSYMBOLS_API LLSym_TypeGetNumChildren ( LLSymTypeHandle  typeHandle,
uint32_t *  out_NumChildren 
)

It returns the number of children of the type handle given as argument of the function.

Parameters
typeHandlethe parent type handle.
out_NumChildrenan output parameter containing the number of children.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeGetProperties()

LLSYMBOLS_API LLSym_TypeGetProperties ( LLSymTypeHandle  typeHandle,
uint32_t *  out_Properties 
)

It returns as a bitmask the various flags of the request type (see enum LLSymTypeProperty)

Parameters
typeHandlethe type handle object.
out_Propertiesan output parameter receiving the bitmask of the type information
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeGetSize()

LLSYMBOLS_API LLSym_TypeGetSize ( LLSymTypeHandle  typeHandle,
uint32_t *  out_Size 
)

It returns the size of the type represented by the handle given as argument of the function.

Parameters
typeHandlethe handle representing the type.
out_Sizean output parameter containing the size.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeIsArray()

LLSYMBOLS_API LLSym_TypeIsArray ( LLSymTypeHandle  typeHandle,
bool_t *  out_IsArray 
)

It checks whether the type given a argument of the function is an array or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call.

Parameters
typeHandlethe handle representing the type.
out_IsArrayan output parameter containing the result of the check.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeIsBasic()

LLSYMBOLS_API LLSym_TypeIsBasic ( LLSymTypeHandle  typeHandle,
bool_t *  out_IsBasic 
)

It checks whether the type given a argument of the function is basic or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call.

Parameters
typeHandlethe handle representing the type.
out_IsBasican output parameter containing the result of the check.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeIsComplex()

LLSYMBOLS_API LLSym_TypeIsComplex ( LLSymTypeHandle  typeHandle,
bool_t *  out_IsComplex 
)

It checks whether the type given a argument of the function is complex or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call.

Parameters
typeHandlethe handle representing the type.
out_IsComplexan output parameter containing the result of the check.
Returns
LLSymResult a return value for this function.

◆ LLSym_TypeIsFunctionBlock()

LLSYMBOLS_API LLSym_TypeIsFunctionBlock ( LLSymTypeHandle  typeHandle,
bool_t *  out_IsFunctionBlock 
)

It checks whether the type given a argument of the function is a function block or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call.

Parameters
typeHandlethe handle representing the type.
out_IsFunctionBlockan output parameter containing the result of the check.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeIsInteger()

LLSYMBOLS_API LLSym_TypeIsInteger ( LLSymTypeHandle  typeHandle,
bool_t *  out_IsInteger 
)

It checks whether the type given a argument of the function is integer or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call.

Parameters
typeHandlethe handle representing the type.
out_IsIntegeran output parameter containing the result of the check.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeIsNumeric()

LLSYMBOLS_API LLSym_TypeIsNumeric ( LLSymTypeHandle  typeHandle,
bool_t *  out_IsNumeric 
)

It checks whether the type given a argument of the function is numeric or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call.

Parameters
typeHandlethe handle representing the type.
out_IsNumerican output parameter containing the result of the check.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeIsSigned()

LLSYMBOLS_API LLSym_TypeIsSigned ( LLSymTypeHandle  typeHandle,
bool_t *  out_IsSigned 
)

It checks whether the type given a argument of the function is signed or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call.

Parameters
typeHandlethe handle representing the type.
out_IsSignedan output parameter containing the result of the check.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeIsString()

LLSYMBOLS_API LLSym_TypeIsString ( LLSymTypeHandle  typeHandle,
bool_t *  out_IsString 
)

It checks whether the type given a argument of the function is a String or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call.

Parameters
typeHandlethe handle representing the type.
out_IsStringan output parameter containing the result of the check.
Returns
LLSymResult a return code for this function.

◆ LLSym_TypeIsStruct()

LLSYMBOLS_API LLSym_TypeIsStruct ( LLSymTypeHandle  typeHandle,
bool_t *  out_IsStruct 
)

It checks whether the type given a argument of the function is a struct or not. You can also use LLSym_TypeGetProperties to get all the properties as flag in one call.

Parameters
typeHandlethe handle representing the type.
out_IsStructan output parameter containing the result of the check.
Returns
LLSymResult a return code for this function.

◆ LLSym_WriteGroup()

LLSYMBOLS_API LLSym_WriteGroup ( LLSymGroupHandle  groupHandle)

Write the values of all the tags of the group in a row.

Parameters
groupHandleLLSymGroupHandle of the selected group
Returns
LLSymResult a return code for this function.

◆ LLSym_WriteMemory()

LLSYMBOLS_API LLSym_WriteMemory ( LLSymWorkspaceHandle  wksHandle,
llsym_addr_t  address,
const void *  buf,
uint32_t  size 
)

DEPRECATED - Command not implemented.

Parameters
wksHandle
address
buf
size
Returns
LLSymResult symResNotImplemented.