StringTrimRight関数の働き・役割
StringTrimRight関数は、文字列の末尾にある改行文字、スペース、およびタブを削除するために使用されます。
StringTrimRight関数を使用することで、文字列の末尾から不要な空白を取り除き、文字列の整形やフォーマットを行いやすくすることができます。
StringTrimRight関数の引数について
StringTrimRight関数は以下の引数を取ります。
int StringTrimRight(string& string_var);
第1引数は、処理対象の文字列です。種類はstringで、[in][out]属性を持ちます。このため、StringTrimRight関数呼び出し後に文字列自体が変更されます。
※このあたりの仕組みについては↓の参照渡しに関する記事をご参照ください。
StringTrimRight関数の戻り値について
StringTrimRight関数は、削除された改行文字、スペース、およびタブの数を返します。エラーが発生した場合は、GetLastError関数を使用してエラーコードを取得できます。
※GetLastError関数についての詳細は↓の記事をご参照ください
StringTrimRight関数を使う際の注意点
元の文字列は直接変更されます。戻り値として新しい文字列は返されません。
空白文字には、スペース、タブ、改行が含まれます。
StringTrimRight関数を使ったサンプルコード
以下は、StringTrimRight関数を使用して文字列の末尾にある空白を削除するサンプルコードです。
void OnStart()
{
// 右側に6つのスペースを含むソース文字列を定義します
string text = "右側のスペースはすべてこの文字列から削除されます ";
// ソース文字列をログで表示します
PrintFormat("元の文字列:\n'%s'", text);
// 右側のスペースをすべて削除し、削除された文字数と結果の文字列をログに表示します
int num = StringTrimRight(text);
PrintFormat("StringTrimRight関数は右側から %d 文字を削除しました。結果の文字列は:\n'%s'", num, text);
/*
結果:
元の文字列:
'右側のスペースはすべてこの文字列から削除されます '
StringTrimRight関数は右側から 6 文字を削除しました。結果の文字列は:
'右側のスペースはすべてこの文字列から削除されます'
*/
}
サンプルコードに使われた関数や文法要素の簡単な解説
OnStart関数は、スクリプトの実行が開始されたときに自動的に呼び出される関数です。
PrintFormat関数は、指定したフォーマットに従ってメッセージをエキスパートログに出力するための関数です。デバッグ情報や結果を確認するために使用します。
StringTrimRight関数は、指定した文字列の末尾にある改行文字、スペース、およびタブを削除するための関数です。削除された改行文字、スペース、およびタブの数を返します。
このサンプルコードでは、文字列「右側のスペースはすべてこの文字列から削除されます 」の末尾にある空白を削除する操作を行っています。StringTrimRight関数の実行結果はエキスパートログに出力され、削除された文字数と結果の文字列が表示されます。元の文字列が変更されていることが確認できます。
StringTrimRight関数を活用することで、文字列の末尾にある不要な空白を効率的に削除し、文字列の整形やフォーマットがより簡単になります。これにより、文字列データの処理や操作がより柔軟になります。
＜参照＞
StringAdd関数/StringBufferLen関数/StringCompare関数/StringLen関数/StringConcatenate関数/StringFill関数/StringInit関数/StringFind関数/StringGetCharacter関数/StringSetLength関数/StringReserve関数/StringReplace関数/StringSetCharacter関数/StringSplit関数/StringSubstr関数/StringToLower関数/StringToUpper関数/StringTrimLeft関数
