bz_ApiString

Available since 2.4.0

A text string utility class that is used by the BZFS API for passing text back to a plug-in from various events and functions. The class contains a number of utility methods commonly used by plug-ins.

Constructors

bz_ApiString ()
bz_ApiString (const char*)
bz_ApiString (const std::string&)
bz_ApiString (const bz_ApiString&)

Operators

=

Return type: bz_ApiString&

Supported data types:

const bz_ApiString&

const std::string&

const char*

==

Return type: bool

Supported data types:

const bz_ApiString&

const std::string&

const char*

!=

Return type: bool

Supported data types:

const bz_ApiString&

const std::string&

const char*

Methods

unsigned int size()

The length of the string

bool empty()

Whether or not the string is empty

const char* c_str()

Return a const char*

void format(const char* fmt, ...)

Set the contents of the string to the specified format

Parameters
const char*	fmt	A string that may contain format specifiers

void replaceAll(const char* target, const char* with)

Find all instances of `target` and replace it with `with`

Parameters
const char*	target
const char*	with

void tolower()

Convert to lowercase

void toupper()

Convert to uppercase

void urlEncode()

Converts the string into a URL encoded string

Other Objects

• bz_APIIntList
• bz_BasePlayerRecord
• bz_BaseURLHandler
• bz_Time

Back to bzfs API Types