CreateStringBuilder()

Syntax

Result = CreateStringBuilder(#StringBuilder [, IncrementLength])

Create a new string builder object.

Parameters

#StringBuilder	The number to identify the new string builder. #PB_Any can be used to auto-generate this number.
IncrementLength (optional)	The length (in characters) by which the internal buffer will grow when more space is needed. If not specified, a default increment length of 8192 characters will be used.

Return value

Returns nonzero if the string builder was created successfully and zero if there was an error. If #PB_Any was used as the #StringBuilder parameter then the new generated number is returned on success.

Remarks

A new string builder starts with an empty string. Use AppendStringBuilderString() or AppendStringBuilderStringN() to add content to it. When finished building the string, use GetStringBuilderString() to retrieve the final result.

Example

  CreateStringBuilder(0)

  AppendStringBuilderString(0, "Hello ")
  AppendStringBuilderString(0, "World!")
    
  Result$ = GetStringBuilderString(0)
  Debug Result$

See Also

AppendStringBuilderString(), AppendStringBuilderStringN(), GetStringBuilderString(), ResetStringBuilder(), FreeStringBuilder()

Supported OS

All