PrlApi_GetResultDescription Function

Evaluates a return code and returns a description of the problem.

Syntax

PRL_RESULT PrlApi_GetResultDescription(
    PRL_RESULT nErrCode, 
    PRL_BOOL bIsBriefMessage, 
    PRL_BOOL bFormated, 
    PRL_STR sErrString, 
    PRL_UINT32_PTR pnErrStringBufLength
);

File

PrlApiCore.h

Parameters

nErrCode

A return code to get the description for.

bIsBriefMessage

Specifies whether to obtain a long or a brief description of the problem. PRL_TRUE specifies to obtain a brief message. PRL_FALSE specifies to obtain a long message.

bFormated

Specifies whether HTML tags used for text formatting should be included in the resulting string.

sErrString

[out] A pointer to a buffer that receives the result (a UTF-8 encoded, null-terminated string).

pnErrStringBufLength

[in] The size of the output buffer (in bytes). Set the buffer pointer to null and this parameter's value to zero to receive the required size. [out] The required output buffer size.

PRL_TRUE

include HTML tags; PRL_FALSE - do not include the tags.

Returns

PRL_RESULT. Possible values are:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_BUFFER_OVERRUN - the size of the output buffer is not large enough. The parameter that is used to specify the size will contain the required size.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

All synchronous functions in the Parallels API return PRL_RESULT - a numeric return code used to evaluate the success or failure of the operation. If the return code indicates a failure, the PrlApi_GetResultDescription function can be used to obtain the description of the problem.

Links

System Functions