PrlDispCfg_GetDefaultBackupServer Function

Returns the default backup server host name or IP address.

Syntax

PRL_RESULT PrlDispCfg_GetDefaultBackupServer(
    PRL_HANDLE hDispConfig, 
    PRL_STR sBackupServer, 
    PRL_UINT32_PTR pnBackupServerBufLength
);

File

PrlApi.h

Parameters

hDispConfig

A handle of type PHT_DISP_CONFIG.

sBackupServer

[out] Pointer to a buffer that receives the backup server host name or IP address (a UTF-8 encoded, null-terminated string).

pnBackupServerBufLength

[in] The size of the output buffer (in bytes). Set the buffer pointer to null and this 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.

Links

PrlApi.h, PHT_DISP_CONFIG