PrlDispCfg_GetDefaultBackupDirectory Function

Returns PATH to the default backup directory.

Syntax

PRL_RESULT PrlDispCfg_GetDefaultBackupDirectory(
    PRL_HANDLE hDispConfig, 
    PRL_STR sBackupDirectory, 
    PRL_UINT32_PTR pnBackupDirectoryBufLength
);

File

PrlApiDisp.h

Parameters

hDispConfig

A handle of type PHT_DISP_CONFIG.

sBackupDirectory

[out] Pointer to a buffer that receives PATH to the backup directory (a UTF-8 encoded, null-terminated string).

pnBackupDirectoryBufLength

[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

PHT_DISP_CONFIG