Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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.

ValueMeaning
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.

 

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

VsWriter.h (include Vss.h or VsWriter.h)

Library

VssApi.lib

See also

IVssComponent
IVssComponent::GetBackupOptions
IVssBackupComponents::SetRestoreOptions

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft. All rights reserved.