PrlLic_GetUserName Function

Returns the license user name.

Syntax

PRL_RESULT PrlLic_GetUserName(
    PRL_HANDLE hLicense, 
    PRL_STR sUserName, 
    PRL_UINT32_PTR pnUserNameBufLength
);

File

PrlApi.h

Parameters

hLicense

A handle of type PHT_LICENSE identifying the license.

sUserName

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

pnUserNameBufLength

[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_NO_DATA - the specified license object does not contain license data.

PRL_ERR_SUCCESS - function completed successfully.

Links

PrlApi.h, PHT_LICENSE