SmcWGetErrorString

Function

Converts error code content to character string.

Format

Ret = SmcWGetErrorString( ErrorCode, ErrorString )

Parameters

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

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

Return Value

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

See also: Error code details

Remarks

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

This function can be executed even if the axis is in operation.

Example

VB.NET
Dim Ret As Integer
Dim ErrorCode As Short
Dim ErrorString As StringBuilder
Ret = SmcWGetErrorString( ErrorCode , ErrorString )

C, C++
long Ret;
long ErrorCode;
char ErrorString[256];
Ret = SmcWGetErrorString( ErrorCode , ErrorString );

C#
int Ret;
int ErrorCode;
string ErrorString;
Ret = Smc.WGetErrorString( ErrorCode , out ErrorString );

Python
Ret = ctypes.c_long()
ErrorCode = ctypes.c_long()
ErrorString = ctypes.create_string_buffer(256)
Ret.value = csmc.SmcWGetErrorString( ErrorCode , ErrorString )