StringInit

指定された記号で文字列を初期化し、指定された文字列の長さを提供します。

bool StringInit(
string& string_var, // 初期化される文字列
int new_len=0, // 初期化後の必要な文字列の長さ
ushort character=0 // 初期化に使用されるシンボル
);

パラメータ

string_var

[in][out] 初期化及び初期化解除される文字列

new_len=0

[in] 初期化後の文字列の長さlength=0 の場合、文字列は初期化解除されます。つまり、文字列バッファはクリアされバッファアドレスがゼロに設定されます。

character=0

[in] 文字列に書き込むシンボル

戻り値

成功の場合は true、それ以外の場合は false。エラーコードを取得するには、GetLastError()が呼ばれます。

注意事項

character=0 及び新しい長さを示すnew_len > 0 の場合、指定された長さの文字列のバッファが配布され、ゼロで満たされます。バッファ全体に文字列ターミネータが記入されているため、文字列の長さはゼロに等しくなります。

例:

void OnStart()
{
//---
string str;
StringInit(str,200,0);
Print("str = ",str,": StringBufferLen(str) = ",
StringBufferLen(str)," StringLen(str) = ",StringLen(str));
}
/* 結果
str = : StringBufferLen(str) = 200 StringLen(str) = 0
*/

参照

StringBufferLen、StringLen

StringGetCharacter

StringLen