SsiGetErrorString

Function

Get the error string from the error code.

Format

Ret = SsiGetErrorString ( ErrorCode , ErrorString )

Parameters

ErrorCode [ C, C++: long ] [ Python: ctypes.c_long ]
Specify the return value of each function.

ErrorString [ C, C++: char * ] [ Python: ctypes.c_char_p ]
Specify the base address of the buffer to store the error string. The maximum length of the string is 256 characters.

Return Value

Ret [ C, C++: long ] [ Python: ctypes.c_long ]

Definition

Value

[Dec]

Description

SSI_ERR_SUCCESS

0

Succeeded

SSI_ERR_DLL_BUFF_ADDRESS

10100

Invalid data buffer address.

The others (See also: Details of Error Code)

Initial Value

None

Remarks

It is an utility function that returns the meaningful string for the error code. Please use this function for the error processing.

Example

C, C++

long Ret;
char ErrorString[256];
Ret = SsiGetErrorString(ErrorCode, &ErrorString[0]);
 

Python

Ret = ctypes.c_long()
ErrorString = ctypes.create_string_buffer(256)
Ret.value = cssi.SsiGetErrorString(ErrorCode, ErrorString)
 

See Also

None