Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlBackupFile_GetRestorePath Function
PHT_BACKUP_FILE

Returns path that should be used to restore backed up file.

Syntax
PRL_RESULT PrlBackupFile_GetRestorePath(
    PRL_HANDLE hFile, 
    PRL_STR sPath, 
    PRL_UINT32_PTR pnBufLength
);
File

PrlApiBackup.h

Parameters

hFile
A handle of type PHT_BACKUP_FILE

sPath
[out] A pointer to a buffer that receives the result (a UTF-8 encoded, null-terminated string).
pnBufLength
[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: 

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. 

Remarks

Note that restore file path value can differ from original file path.

Links
© 2021 Parallels International GmbH. All rights reserved.