PrlBackupResult_GetBackupUuid Function

Returns the UUID (universally unique ID) of the created backup

Syntax

PRL_RESULT PrlBackupResult_GetBackupUuid(
    PRL_HANDLE hBackupResult, 
    PRL_STR sBackupUuid, 
    PRL_UINT32_PTR pnBackupUuidBufLength
);

File

PrlApiDisp.h

Parameters

hBackupResult

A handle of type PHT_BACKUP_RESULT identifying the information about created backup.

sBackupUuid

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

pnBackupUuidBufLength

[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_SUCCESS - function completed successfully.

Links

PHT_BACKUP_RESULT