Str 関数

[アーティクル]
09/30/2008

更新 : 2007 年 11 月

数値を表す文字列を返します。

Public Shared Function Str(ByVal Number As Object) As String

パラメータ

Number
必ず指定します。任意の有効な数値式を含むオブジェクト型 (Object) の値です。

例外

例外の種類	エラー番号	条件
ArgumentNullException	5	Number が指定されていません。
InvalidCastException	5	Number が数値型ではありません。

非構造化エラー処理を使用する Visual Basic 6.0 アプリケーションをアップグレードする場合は、"エラー番号" の列を参照してください(エラー番号を Number プロパティ (Err オブジェクト) と比較することもできます)。ただし、可能であれば、このようなエラー制御は Visual Basic の構造化例外処理の概要に置き換えることを検討してください。

解説

数値を文字列に変換する場合、文字列の先頭には Number の記号用のスペースが確保されます。Number が正である場合、返された文字列には先頭にスペースが含まれます。これは、明示されないプラス記号があることを意味します。負の数にはマイナス記号 (-) が明示され、先頭にスペースは挿入されません。

Format 関数を使用して、数値を日付、時刻、通貨、およびその他のユーザー定義の書式に変換できます。Str 関数とは異なり、Format 関数には Number の先頭に記号用のスペースは含まれません。

メモ :
Str 関数は、ピリオド (.) だけを有効な小数点の記号として認識します。国際対応のアプリケーションなどで、ピリオドと異なる小数点の記号が使われている場合は、CStr 関数または Format 関数を使用して、数値を文字列に変換してください。特定の文化圏における数値の文字表現を調べるには、その数値の ToString(IFormatProvider) メソッドを使用します。たとえば、Double 型の値を文字列に変換するには、ToString を使用します。

Str 関数は、ピリオド (.) だけを有効な小数点の記号として認識します。国際対応のアプリケーションなどで、ピリオドと異なる小数点の記号が使われている場合は、CStr 関数または Format 関数を使用して、数値を文字列に変換してください。特定の文化圏における数値の文字表現を調べるには、その数値の ToString(IFormatProvider) メソッドを使用します。たとえば、Double 型の値を文字列に変換するには、ToString を使用します。

使用例

Str 関数を使って、数値の String 表現を返す例を次に示します。正の数を文字列に変換すると、先頭にはプラス記号用のスペースが常に確保されます。

Dim TestString As String
' Returns " 459".
TestString = Str(459)
' Returns "-459.65".
TestString = Str(-459.65)
' Returns " 459.001".
TestString = Str(459.001)