IVssBackupComponents::SetRestoreOptions method

The SetRestoreOptions method sets a string of private, or writer-dependent, restore parameters for a writer component.

Syntax


HRESULT SetRestoreOptions(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE componentType,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszRestoreOptions
);

Parameters

writerId [in]

Writer identifier.

componentType [in]

Type of the component. See VSS_COMPONENT_TYPE for the possible values.

wszLogicalPath [in]

Null-terminated wide character string containing the logical path of the component. For more information, see Logical Pathing of Components.

The value of the string containing the logical path used here should be the same as was used when the component was added to the backup set using IVssBackupComponents::AddComponent.

The logical path can be NULL.

There are no restrictions on the characters that can appear in a non-NULL logical path.

wszComponentName [in]

Null-terminated wide character string containing the name of the component.

The string cannot be NULL and should contain the same component name as was used when the component was added to the backup set using IVssBackupComponents::AddComponent.

wszRestoreOptions [in]

Null-terminated wide character string containing the private string of restore parameters. For more information see Setting VSS Restore Options.

Return value

The following are the valid return codes for this method.

ValueMeaning
S_OK

Successfully set the previous backup time stamp.

E_INVALIDARG

One of the parameter values is not valid.

E_OUTOFMEMORY

The caller is out of memory or other system resources.

VSS_E_BAD_STATE

The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.

VSS_E_OBJECT_NOT_FOUND

The backup component does not exist.

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.

VSS_E_UNEXPECTED

Unexpected error. The error code is logged in the error log file. For more information, see Event and Error Handling Under VSS.

Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP:  This value is not supported until Windows Server 2008 R2 and Windows 7. E_UNEXPECTED is used instead.

 

Remarks

This method must be called before IVssBackupComponents::PreRestore.

The exact syntax and content of the restore options set by the wszRestoreOptions parameter of the SetRestoreOptions method will depend on the specific writer being contacted.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

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

Library

VssApi.lib

See also

IVssBackupComponents
IVssBackupComponents::PreRestore
VSS_COMPONENT_TYPE

 

 

Show: