IVssComponent::GetRestoreTarget method (vswriter.h)

  • Article

The GetRestoreTarget method returns the restore target (in terms of the VSS_RESTORE_TARGET enumeration) for the current component.

Either a writer or a requester can call this method. It can be called only during a restore operation.

Syntax

HRESULT GetRestoreTarget(
  [out] VSS_RESTORE_TARGET *pTarget
);

Parameters

[out] pTarget

The address of a caller-allocated variable that receives a VSS_RESTORE_TARGET enumeration value that specifies the restore target.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
 Successfully returned the attribute value.
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.
VSS_E_OBJECT_NOT_FOUND
 The specified item was not found.

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

See also

IVssComponent