Difference between revisions of "Bz APIString"

From BZFlagWiki
Jump to: navigation, search
m (Bz ApiString moved to BzApiString: Class has been renamed in the API)
(Changing names...)
Line 2: Line 2:
  
 
==Overview==
 
==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.
+
The bzApiString 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==
 
==Construction==
plug-ins should never create a bz_ApiString, they are only passed back to the plug-in by BZFS.
+
plug-ins should never create a bzApiString, they are only passed back to the plug-in by BZFS.
  
 
==Assignment==
 
==Assignment==
Line 11: Line 11:
  
 
==Boolean Operators==
 
==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.
+
The standard == and != operators are provided to assign allow testing of bzApiStrings with other bzApiStrings, std::strings and const char* pointers.

Revision as of 01:46, 8 May 2009

BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.


Overview

The bzApiString 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 bzApiString, 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 bzApiStrings with other bzApiStrings, std::strings and const char* pointers.