AioGetErrorString

Function

Converts error code content to string. This function supports multi-process.

Format

Ret = AioGetErrorString ( ErrorCode , ErrorString )

Parameters

ErrorCode [ VB.NET : Integer ] [ C, C++ : long ] [ C# : int ] [ Python : ctypes.c_long ]
Specifies error code.

ErrorString [ VB.NET : StringBuilder ] [ C, C++ : char * ] [ C# : out StringBuilder ] [ Python : ctypes.c_char_p ]
Specifies the pointer to the buffer for storing string.
Make sure that the size of buffer is greater than 256 bytes.

Return value

Ret [ VB.NET : Integer ] [ C, C++ : long ] [ C# : int ] [ Python : ctypes.c_long ]

Return values

Content

0

Normality completion

10180

Pointer to ErrorString is NULL
Specify the address of variable to parameter.

Remarks

Make sure that the size of buffer for storing string is greater than 256 bytes.

If the device is in operation, this function cannot be performed.

Example

Stores the content of error code 10000 to ErrorString.

VB.NET

Dim Ret As Integer
Dim ErrorString As New StringBuilder("", 256)
Ret = AioGetErrorString ( 10000 , ErrorString )
 

C, C++

long Ret;
char ErrorString[256];
Ret = AioGetErrorString ( 10000 , ErrorString );
 

C#

int Ret;
string ErrorString;
Ret = aio.GetErrorString ( 10000 , out ErrorString );
 

Python

Ret = ctypes.c_long()
ErrorString = ctypes.create_string_buffer(256)
Ret.value = caio.AioGetErrorString ( 10000 , ErrorString )
 

Stores the string "The device name which wasn't registered by a device manager was specified." to ErrorString.