bz APIString

From BZFlagWiki
Revision as of 01:45, 8 May 2009 by Xalendare (Talk | contribs) (Bz ApiString moved to BzApiString: Class has been renamed in the API)

Jump to: navigation, search
BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.


Overview

The bz_ApiString is 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.

Construction

plug-ins should never create a bz_ApiString, they are only passed back to the plug-in by BZFS.

Assignment

The standard = operator is provided to assign the value in a string, from other strings, std::strings, and const char pointers.

Boolean Operators

The standard == and != operators are provided to assign allow testing of bz_ApiStrings with other bz_ApiStrings, std::strings and const char* pointers.