Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The GetBackupMetadata method retrieves private, writer-specific backup metadata that might have been set during a PrepareForBackup event by CVssWriter::OnPrepareBackup using IVssComponent::SetBackupMetadata.
Only a writer can call this method.
Syntax
HRESULT GetBackupMetadata(
[out] BSTR *pbstrData
);
Parameters
[out] pbstrData
The address of a caller-allocated variable that receives a string containing the backup metadata that was added during an OnPrepareBackup event.
Return value
The following are the valid return codes for this method.
| Value | Meaning |
|---|---|
|
Successfully returned the attribute value. |
|
There is no backup metadata associated with this component. |
|
One of the parameter values is not valid. |
|
The caller is out of memory or other system resources. |
|
The XML document is not valid. Check the event log for details. For more information, see Event and Error Handling Under VSS. |
Remarks
This method can be called at any time depending on the logic of a given writer.
If no backup metadata has been set, GetBackupMetadata returns S_FALSE.
If the call to GetBackupMetadata is successful, the caller is responsible for freeing the string that is returned in the pbstrMetadata parameter by calling the SysFreeString function.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | vswriter.h (include Vss.h, VsWriter.h) |
| Library | VssApi.lib |