PrlApi_GuestToString Function

Returns a readable string representation given guest OS ID.

Syntax

PRL_RESULT PrlApi_GuestToString(
    PRL_UINT32 nGuestId, 
    PRL_STR sGuestString, 
    PRL_UINT32_PTR pnGuestStringSize
);

PrlApiCore.h

nGuestId

[in] Guest OS ID

sGuestString

[out] Guest OS name as string.

pnPathStringSize

[in] The size of string containing guest OS name

PRL_RESULT. Possible values are:

PRL_ERR_INVALID_ARG - null pointer to the string size was passed.

PRL_ERR_SUCCESS - function completed successfully.