StringToUpper関数の働き・役割
StringToUpper関数は、指定した文字列内のすべての文字を大文字に変換するために使用されます。StringToUpper関数を使用することで、文字列の大文字と小文字を統一し、比較や検索を行いやすくすることができます。
StringToUpper関数の引数について
StringToUpper関数は以下の引数を取ります。
bool StringToUpper(string& string_var);
第1引数は、変換対象の文字列です。種類はstring型で、[in][out]属性を持ちます。このため、StringToUpper関数呼び出し後に文字列自体が変更されます。
※このあたりの仕組みについては↓の参照渡しに関する記事をご参照ください。
StringToUpper関数の戻り値について
StringToUpper関数は、操作が成功した場合にtrueを返し、失敗した場合にfalseを返します。エラーが発生した場合は、GetLastError関数を使用してエラーコードを取得できます。
※GetLastError関数についての詳細は↓の記事をご参照ください
StringToUpper関数を使う際の注意点
元の文字列自体が変更されます。新しい文字列は戻り値としては返されません。
特殊文字（アルファベット以外の記号や数字）はそのまま保持され、小文字に変換されるのはアルファベット文字のみです。
StringToUpper関数を使ったサンプルコード
以下は、StringToUpper関数を使用して文字列を大文字に変換するサンプルコードです。
void OnStart()
{
// 操作対象の文字列を小文字で定義します
string text = "hello world!";
// ソース文字列をログで表示します
Print("元の文字列:\n", text);
// すべての文字列文字を大文字に変換し、結果をログに表示します
if(StringToUpper(text))
Print("StringToUpper関数使用後の元の文字列:\n", text);
/*
結果:
元の文字列:
hello world!
StringToUpper関数使用後の元の文字列:
HELLO WORLD!
*/
}
OnStart関数は、スクリプトの実行が開始されたときに自動的に呼び出される関数です。
Print関数は、指定したメッセージをエキスパートログに出力するための関数です。デバッグ情報や結果を確認するために使用します。
StringToUpper関数は、指定した文字列内のすべての文字を大文字に変換するための関数です。文字列自体が変更されるため、変換後の文字列をそのまま使用することができます。
このサンプルコードでは、文字列「hello world!」を大文字に変換する操作を行っています。StringToUpper関数の実行結果はエキスパートログに出力され、変換された文字列が表示されます。元の文字列が変更されていることが確認できます。
StringToUpper関数を活用することで、文字列の大文字と小文字を統一し、文字列比較や検索がより簡単になります。これにより、文字列データの処理や操作がより柔軟になります。
＜参照＞
StringAdd関数/StringBufferLen関数/StringCompare関数/StringLen関数/StringConcatenate関数/StringFill関数/StringInit関数/StringFind関数/StringGetCharacter関数/StringSetLength関数/StringReserve関数/StringReplace関数/StringSetCharacter関数/StringSplit関数/StringSubstr関数/StringToLower関数/StringTrimLeft関数/StringTrimRight関数
