PrlReport_SetDescription Function

Sets the specified problem report description.

Syntax

PRL_RESULT PrlReport_SetDescription(
    PRL_HANDLE hProblemReport, 
    PRL_CONST_STR sNewDescription
);

hProblemReport

[in] A handle of type PHT_PROBLEM_REPORT identifying the problem report object.

sNewDescription

[in] The value to set - must be a a UTF-8 encoded, null-terminated string.

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.