AioGetErrorString

■機能

エラーコードの内容を文字列に変換します。

 

■書式

Ret = AioGetErrorString ( ErrorCode , ErrorString )

 

■引数

ErrorCode [ VB.NET:Integer C,C++:long C#:int ]

エラーコードを指定します。

 

ErrorString [ VB.NET:StringBuilder C,C++:char * C#:StringBuilder ]

文字列を格納するバッファのポインタを指定します。

バッファは256バイト確保してください。

 

■戻り値

Ret [ VB.NET:Integer C:long C#:int ]

定義

意味

AIO_ERR_SUCCESS

0

正常終了

AIO_ERR_PTR_ERR_STR

10180

ErrorStringのポインタがNULLです。

 

参照:エラーコード詳細

 

■説明

エラーコードから、意味のわかる文字列を返すユーティリティ関数です。エラー処理にご使用ください。

文字列を格納するバッファのサイズは必ず256バイト分確保してください。

 

VB.NETでの例)

Dim ErrorString As New System.Text.StringBuilder("", 256)

VCでの例)

char DeviceName[ 256 ];

C#での例)

StringBuilder ErrorString = new StringBuilder(256); 

 

■使用例

エラーコード10000の内容をErrorStringに格納します。

VB.NET      Ret = AioGetErrorString ( 10000 , ErrorString )

C,C++        Ret = AioGetErrorString ( 10000 , ErrorString );

C#             Ret = AIO.ccapaio.AioGetErrorString ( 10000 , ErrorString );

 

ErrorStringには「設定ファイルに登録されていないデバイス名が指定されました」という文字列が格納されます。

 

■関連項目

なし