Xalendare: BzAPIStringList moved to Bz APIStringList over redirect: Undoing previous move...

2009-05-08T01:55:07Z

BzAPIStringList moved to Bz APIStringList over redirect: Undoing previous move...

← Older revision		Revision as of 01:55, 8 May 2009
(No difference)

Xalendare: Bz APIStringList moved to BzAPIStringList: Name out-of-date

2009-05-08T01:52:45Z

Bz APIStringList moved to BzAPIStringList: Name out-of-date

← Older revision		Revision as of 01:52, 8 May 2009
(No difference)

JeffM2501 at 20:58, 26 September 2008

2008-09-26T20:58:54Z

← Older revision		Revision as of 20:58, 26 September 2008
Line 1:		Line 1:
	{{BZFS_API_Doc}}{{BZFS_API_Class}}		{{BZFS_API_Doc}}{{BZFS_API_Class}}
	==~~Prototype~~==		==Declaration==
	class BZF_API bz_APIStringList {		class BZF_API bz_APIStringList {
	public:		public:

AAA: initial content

2008-05-26T00:06:23Z

initial content

New page

{{BZFS_API_Doc}}{{BZFS_API_Class}}
==Prototype==
class BZF_API bz_APIStringList {
public:
bz_APIStringList();
bz_APIStringList(const bz_APIStringList &r);
bz_APIStringList(const std::vector<std::string> &r);

~bz_APIStringList();

void push_back ( const [[bz_ApiString]] &value );
void push_back ( const std::string &value );
bz_ApiString get ( unsigned int i );

const bz_ApiString& operator[] (unsigned int i) const;
bz_APIStringList& operator= ( const bz_APIStringList &r );
bz_APIStringList& operator= ( const std::vector<std::string> &r );

unsigned int size ( void );
void clear ( void );

void tokenize ( const char* in, const char* delims, int maxTokens = 0, bool useQuotes = false);
};

BZF_API bz_APIStringList* bz_newStringList ( void );
BZF_API void bz_deleteStringList( bz_APIStringList * l );

==Description==
Contains a list of strings.
Comparable to std::vector<std::string>

Plugins generally should never create Bz_APIStringList objects, only copy the data out.

==Member Access==
[[bz_ApiString]] get ( unsigned int i );

const bz_ApiString& operator[] (unsigned int i) const;

===Parameters===
; unsigned int i : bz_ApiString element to return

==Functions==
===size===
unsigned int size ( void );

Returns the number of elements on the list

===clear===
void clear ( void );

Removes all elements from the list

===tokenize===
void tokenize ( const char* in, const char* delims, int maxTokens = 0, bool useQuotes = false);

Appends a list generated from a tokenized string. Use of this function is discouraged, the tokenize() function available in plugin_utils is prefered.

Bz APIStringList - Revision history

Xalendare: BzAPIStringList moved to Bz APIStringList over redirect: Undoing previous move...

Xalendare: Bz APIStringList moved to BzAPIStringList: Name out-of-date

JeffM2501 at 20:58, 26 September 2008

AAA: initial content