CharBufferString.FindFrom (METH) ¶ METHOD FindFrom : INT Searches for a substring within our string, starting at a specified position InOut: Scope Name Type Comment Return FindFrom INT Input cbsToSearchFor REFERENCE TO CharBufferString iSearchStart UINT a position relative to 1, where the search starts
CharBufferString.FromString (METH) ¶ METHOD FromString : BOOL Converts an IEC string value into the internally used representation. The result of the method indicates, whether the processing was successful or not (e.g. CharBufferString.m_Type <> ANY_STRING). If the internally used buffer is not large enough the result is TRUE and only the used buffer size – 1 will be copied. InOut: Scope Name Type Comment Return FromString BOOL Input stString STRING(255) The string to convert @IECCodeConverter_Type: String
CharBufferString.Init (METH) ¶ METHOD Init : BOOL Init method used for using an already existing memory for storing the string InOut: Scope Name Type Comment Return Init BOOL Input pBuffer POINTER TO BYTE The pointer to the buffer containing the string uiBufferSize UINT The size of the buffer (in bytes), where the string is stored. If this value is 0, no memory is allocated and the CharBufferPtr pointer has to be set by calling the Initialize method stringType __SYSTEM.TYPE_CLASS A __SYSTEM.TYPE_CLASS value indicating type of the string
CharBufferString.Initialize (METH) ¶ METHOD Initialize : BOOL Method Initialize must be called in order to pass an already existing CharBufferPtr to this instance. In this case the buffer size is unknown and remains 0. This method can be used if the string is read only. InOut: Scope Name Type Comment Return Initialize BOOL Input cbpSource CharBufferPtr The buffer, where the string is stored this instance represents stringType __SYSTEM.TYPE_CLASS A __SYSTEM.TYPE_CLASS value indicating type of the string
StrDeleteW (FUN) ¶ FUNCTION StrDeleteW Deletes <iLength> characters of <pwst>, beginning at the <iPosition>-th character position. <iPosition> = 1 is the first character. InOut: Scope Name Type Input pwd POINTER TO WORD iLength INT iPosition INT
StrFindW (FUN) ¶ FUNCTION StrFindW : INT Same semantics as Find from the standard.library. A null pointer will lead to a return of -1 InOut: Scope Name Type Comment Return StrFindW INT Input pst1 POINTER TO WSTRING(255) pst2 POINTER TO WSTRING(255) uiSearchStart UINT a position relative to 1, where the search starts
StrIsNullOrEmptyW (FUN) ¶ FUNCTION StrIsNullOrEmptyW : BOOL This function determines if the given string is null or empty InOut: Scope Name Type Comment Return StrIsNullOrEmptyW BOOL Input pstData CharBufferPtr simply a pointer to byte
StrLenW (FUN) ¶ FUNCTION StrLenW : DINT This function determines the length of a string by searching for a terminating zero character. The function will do its work either with native IEC-WStrings or with strings coming from external functions. It will return -1 if the given pointer to String is equal NULL InOut: Scope Name Type Comment Return StrLenW DINT Input pstData CharBufferPtr simply a pointer to byte
StrMidW (FUN) ¶ FUNCTION StrMidW Return <iLength> characters of <pwst>, beginning at the <iPosition>-th character position. <iPosition> = 1 is the first character. InOut: Scope Name Type Comment Input pwst POINTER TO WORD uiInputBufferSize UINT The size of the buffer, where pwst points to iLength INT iPosition INT pwstResult POINTER TO WORD The buffer, where the result will be returned uiResultBufferSize UINT The size of the buffer (in bytes), where the result will be returned
StrPadLeftW (FUN) ¶ FUNCTION StrPadLeftW : BOOL This function generate a padding string and concatenates it with pstFrom to pstTo if the iBufferSize from pstTo is big enough. The function will do its work either with native IEC-Strings or with strings coming from external functions. It will return FALSE and does no concatenation if one of the strings is NULL or the buffer size is not big enough. InOut: Scope Name Type Comment Return StrPadLeftW BOOL Input wPadChar WORD The padding character filling the space from left pstFrom CharBufferPtr simply a pointer to byte pstTo CharBufferPtr simply a pointer to byte diBufferSize DINT the buffer size of pstTo