StringAdd
StringBufferLen
StringCompare
StringConcatenate
StringFill
StringFind
StringGetCharacter
StringInit
StringLen
StringReplace
StringSetCharacter
StringSplit
StringSubstr
StringToLower
StringToUpper
StringTrimLeft
StringTrimRight
StringGetChar
StringSetChar

StringBufferLen

The function returns the size of buffer allocated for the string.

int  StringBufferLen(
   string  string_var      // string
   )

Parameters

string_var

[in] String.

Return Value

The value 0 means that the string is constant and buffer size can't be changed. -1 means that the string belongs to the client terminal, and modification of the buffer contents can have indeterminate results.

Note

Minimal buffer size is equal to 16.

Example:

void OnStart()
  {
   long length=1000;
   string a="a",b="b";
//---
   long i;
   Print("before: StringBufferLen(a) = ",StringBufferLen(a),
         "  StringLen(a) = ",StringLen(a));
   for(i=0;i<length;i++)
     {
      StringAdd(a,b);
     }
   Print("after: StringBufferLen(a) = ",StringBufferLen(a),
         "  StringLen(a) = ",StringLen(a));
  }