PrlResult_GetParamAsString Function

Obtains a string result from the result object.

Syntax

PRL_RESULT PrlResult_GetParamAsString(
    PRL_HANDLE hResult, 
    PRL_STR sParamBuf, 
    PRL_UINT32_PTR pnParamBufSize
);

File

PrlApiCore.h

Parameters

hResult

A handle of type PHT_RESULT identifying the result object.

sParamBuf

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

pnParamBufSize

[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.

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

Use this function when you know that the corresponding function always produces a single string as a result. This function is the equivalent of the PrlResult_GetParamByIndexAsString(hResult, 0, &myString) call (i.e. zero as the index value).

Links

PHT_RESULT