IVssComponent::GetBackupOptions method (vswriter.h)
The GetBackupOptions method returns the backup options specified to the writer that manages the currently selected component or component set by a requester using IVssBackupComponents::SetBackupOptions.
Either a writer or a requester can call this method.
Syntax
HRESULT GetBackupOptions(
[out] BSTR *pbstrBackupOptions
);
Parameters
[out] pbstrBackupOptions
The address of a caller-allocated variable that receives a string containing the backup options for the current writer.
Return value
The following are the valid return codes for this method.
| Value | Meaning |
|---|---|
|
Successfully returned the attribute value. |
|
No backup options have been specified for 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
If no backup options have been set, S_FALSE is returned.
If the call to GetBackupOptions is successful, the caller is responsible for freeing the string that is returned in the pbstrBackupOptions 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 |