PrlSrvInfo_GetHostName Function

Returns the name of the machine hosting the specified Parallels Service.

Syntax

PRL_RESULT PrlSrvInfo_GetHostName(
    PRL_HANDLE hServerInfo, 
    PRL_STR sHostName, 
    PRL_UINT32_PTR pnHostNameBufLength
);

File

PrlApiDisp.h

Parameters

hServerInfo

A handle of type PHT_SERVER_INFO containing the Parallels Service information.

sHostName

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

pnHostNameBufLength

[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 PHT_SERVER_INFO object does not contain any data.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_SERVER_INFO