IVssComponent::GetRestoreOptions method (vswriter.h)

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
);

[out] pbstrRestoreOptions

String containing the restore options of the writer.

The following are the valid return codes for this method.

Value	Meaning
S_OK	Successfully returned the attribute value.
S_FALSE	No restore options have been specified.
E_INVALIDARG	One of the parameter values is not valid.
E_OUTOFMEMORY	The caller is out of memory or other system resources.
VSS_E_INVALID_XML_DOCUMENT	The XML document is not valid. Check the event log for details. For more information, see Event and Error Handling Under VSS.

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.

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