C_GetWarningText

Call C_GetWarningText to get the text of all the warnings issued for the given model. You should first call C_GetNumOfWarnings to find out how many warnings have been issued in total. Each individual warning can then be obtained by calling C_GetWarningText with an Index value in the range 0 to C_GetNumOfWarnings-1 inclusive.

int C_GetWarningText(

TOrcFxAPIHandle ModelHandle,

int Index,

int *lpStage,

LPCTSTR lpWarningText,

int *lpStatus

);

Parameters

ModelHandle (IN)

The handle of the model.

Index (IN)

The index of the warning message, ranging from 0 to C_GetNumOfWarnings-1 inclusive.

lpStage (OUT)

Unused. Callers should pass NULL.

lpWarningText (OUT)

Points to a block of memory to receive the warning string. The block of memory must be large enough for the warning string. To find out how much memory to allocate call C_GetWarningText passing NULL as the lpWarningText parameter and use the return value to determine how much memory to allocate.

lpStatus (OUT)

Points to a variable in which the status result for the function call will be returned.

Return Value

The length of the warning string (including the null-terminating character).

Unicode and ANSI

The Unicode function name is C_GetWarningTextW and the ANSI function name is C_GetWarningTextA.