IVssComponent::GetRestoreOptions method
The GetRestoreOptions method gets the restore options specified to the current writer by a requester using IVssBackupComponents::SetRestoreOptions.
Either a writer or a requester can call this method.
Syntax
HRESULT GetRestoreOptions( [out] BSTR *pbstrRestoreOptions );
Parameters
- pbstrRestoreOptions [out]
-
String containing the restore options of the writer.
Return value
The following are the valid return codes for this method.
| Value | Meaning |
|---|---|
|
Successfully returned the attribute value. |
|
No restore options have been specified. |
|
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
The caller should free the memory held by the pbstrRestoreOptions parameter by calling SysFreeString.
If no restore options have been set, S_FALSE is returned.
Requirements
|
Minimum supported client | Windows XP [desktop apps only] |
|---|---|
|
Minimum supported server | Windows Server 2003 [desktop apps only] |
|
Header |
|
|
Library |
|
See also
Send comments about this topic to Microsoft
Build date: 11/5/2012
