Translates an error number returned as a string.
Syntax
Function NlsGetText (ErrCode, MsgString, MaxLength)
Properties
The NlsGetText function syntax has these parts:
|
Part |
Description |
|
object |
An object expression that evaluates to an object in the Applies To list. |
|
ErrCode |
Integer. The error code returned from a previous eda function call. |
|
MsgString |
String. The error message that corresponds to ErrCode. |
|
MsgString |
Integer. The maximum size, in bytes, to return in MsgString. |
Return Value
Long.
|
Part |
Description |
|
FTK_OK |
Successful. |
|
FTK_BAD_MHANDLE |
Pointer to non-writable memory passed in. |
|
FTK_NO_MESSAGE |
No message exists for error. |
|
FTK_BAD_LENGTH |
String length too small. |
Remarks
The Error originates from iFIX. If the message is longer than specified in MaxLength, then string will be truncated. If no message exists for Error, FTK_NO_MESSAGE will be returned.
The MsgString parameter must be declared as a fixed-length string of 255 characters before calling NlsGetText. For example, you could initialize the MsgString parameter like so:
Dim MsgString As String * 255
