CharBufferPtr (ALIAS) ¶ TYPE CharBufferPtr : POINTER TO BYTE This type will be used for all strings, that the functions of this library can use. Can be interpreted as POINTER TO STRING or POINTER TO WSTRING
CharBufferString (FB) ¶ FUNCTION_BLOCK CharBufferString This function block encapsulates the data of a string based on a byte array, i.e. contains the CharBufferPtr variable pointing to the buffer and the information about the type of (i.e. one-byte string or two-byte string) InOut: Scope Name Type Comment Input m_uiBufferSize UINT The size of the buffer (in bytes), where the string is stored. m_cbpBuffer CharBufferPtr The buffer, where the string is stored this instance represents m_Type __SYSTEM.TYPE_CLASS A __SYSTEM.TYPE_CLASS value indicating type of the string m_AsString POINTER TO STRING(255) Two additional pointers to the buffer used for easier debugging. In the monitoring view the corresponding pointer shows the current value of the buffer as (w)string. m_AsWString POINTER TO WSTRING(255) m_bAllocated BOOL Flag indicating, whether the memory for storing the string was allocated dynamically and has to be freed later Properties: Capacity Characters Length StringType Methods: CharAt CharAtEquals Copy CopyFrom CopyFrom2 Delete FB_Exit FB_Init Find FindFrom FromString Init Initialize Insert Mid Replace Structure: Capacity (Property) CharAt (Method) CharAtEquals (Method) Characters (Property) Copy (Method) CopyFrom (Method) CopyFrom2 (Method) Delete (Method) FB_Exit (Method) FB_Init (Method) Find (Method) FindFrom (Method) FromString (Method) Init (Method) Initialize (Method) Insert (Method) Length (Property) Mid (Method) Replace (Method) StringType (Property)
Public Parts ¶ Ansi CharToUpper (Function) StrCaseCmpA (Function) StrCaseCmpEndA (Function) StrCaseCmpStartA (Function) StrCaseFindA (Function) StrCmpA (Function) StrCmpEndA (Function) StrCmpStartA (Function) StrConcatA (Function) StrCpyA (Function) StrDeleteA (Function) StrFindA (Function) StrIsNullOrEmptyA (Function) StrLenA (Function) StrMidA (Function) StrPadLeftA (Function) StrPadRightA (Function) StrReplaceA (Function) StrToLowerA (Function) StrToUpperA (Function) StrTrimA (Function) StrTrimEndA (Function) StrTrimStartA (Function) CharBufferPtr (Alias) CharBufferString (FunctionBlock) Capacity (Property) CharAt (Method) CharAtEquals (Method) Characters (Property) Copy (Method) CopyFrom (Method) CopyFrom2 (Method) Delete (Method) FB_Exit (Method) FB_Init (Method) Find (Method) FindFrom (Method) FromString (Method) Init (Method) Initialize (Method) Insert (Method) Length (Property) Mid (Method) Replace (Method) StringType (Property) ILocalizedDateTimeNames (Interface) GetDayLong (Method) GetDayShort (Method) GetMonthLong (Method) GetMonthShort (Method) Printf (Function) StuSprintf (Function) StuSprintfW (Function) UTF8 ConvertUTF16toUTF8 (Function) ConvertUTF8toUTF16 (Function) GVL_UTF8 (GVL) IsLegalUTF8 (Function) IsSpaceCharacter (Function) Unicode StrCaseCmpW (Function) StrCaseFindW (Function) StrCmpW (Function) StrConcatW (Function) StrCpyW (Function) StrDeleteW (Function) StrFindW (Function) StrIsNullOrEmptyW (Function) StrLenW (Function) StrMidW (Function) StrPadLeftW (Function) StrPadRightW (Function) StrReplaceW (Function) StrTrimEndW (Function) StrTrimStartW (Function) StrTrimW (Function) WCharToUpper (Function)
Ansi ¶ CharToUpper (Function) StrCaseCmpA (Function) StrCaseCmpEndA (Function) StrCaseCmpStartA (Function) StrCaseFindA (Function) StrCmpA (Function) StrCmpEndA (Function) StrCmpStartA (Function) StrConcatA (Function) StrCpyA (Function) StrDeleteA (Function) StrFindA (Function) StrIsNullOrEmptyA (Function) StrLenA (Function) StrMidA (Function) StrPadLeftA (Function) StrPadRightA (Function) StrReplaceA (Function) StrToLowerA (Function) StrToUpperA (Function) StrTrimA (Function) StrTrimEndA (Function) StrTrimStartA (Function)
CharToUpper (FUN) ¶ FUNCTION CharToUpper : BYTE This function converts a character (i.e. a byte) of a string to uppercase. InOut: Scope Name Type Return CharToUpper BYTE Input byChar BYTE
StrCaseCmpA (FUN) ¶ FUNCTION StrCaseCmpA : INT Does a caseinsensitive comparison of two strings Return values: 0 -> the strings are equal -1 -> pByte1 is less than pByte2 1 -> pByte1 is larger than pByte2 -2 -> Error: An invalid string (ie. Null-Pointer is given) InOut: Scope Name Type Return StrCaseCmpA INT Input pByte1 POINTER TO BYTE pByte2 POINTER TO BYTE
StrCaseCmpEndA (FUN) ¶ FUNCTION StrCaseCmpEndA : INT Does a case insensitive comparison of the end of the string and the suffix Return values: 0 -> end of the string and suffix are equal -1 -> end OF the STRING AND suffix are NOT equal -2 -> Error: An invalid string (ie. Null-Pointer is given) InOut: Scope Name Type Comment Return StrCaseCmpEndA INT Input pString CharBufferPtr Pointer to the string to check. pSuffix CharBufferPtr Pointer to the suffix to find.
StrCaseCmpStartA (FUN) ¶ FUNCTION StrCaseCmpStartA : INT Does a case insensitive comparison of the start of the string and the prefix Return values: 0 -> start of the string and prefix are equal -1 -> start of the string and prefix are NOT equal -2 -> Error: An invalid string (ie. Null-Pointer is given) InOut: Scope Name Type Comment Return StrCaseCmpStartA INT Input pString CharBufferPtr Pointer to the string to check. pPrefix CharBufferPtr Pointer to the prefix to find.
StrCaseFindA (FUN) ¶ FUNCTION StrCaseFindA : INT Similar semantics as Find from the standard.library. Does a case insensitive search. A null pointer will lead to a return of -1 InOut: Scope Name Type Comment Return StrCaseFindA INT Input pst1 POINTER TO STRING(255) pst2 POINTER TO STRING(255) uiSearchStart UINT a position relative to 1, where the search starts
StrCmpA (FUN) ¶ FUNCTION StrCmpA : INT Does a case sensitive comparison of two strings Return values: 0 -> the strings are equal -1 -> pwd1 is less than pwd2 1 -> pwd1 is larger than pwd2 InOut: Scope Name Type Return StrCmpA INT Input pby1 POINTER TO BYTE pby2 POINTER TO BYTE