Edit

IVssComponent::IsSelectedForRestore method (vswriter.h)

  • Article

The IsSelectedForRestore method determines whether the current component has been selected to be restored.

Either a writer or a requester can call this method.

Syntax

HRESULT IsSelectedForRestore(
  [out] bool *pbSelectedForRestore
);

Parameters

[out] pbSelectedForRestore

The address of a caller-allocated variable that receives true if the component has been selected to be restored, or false otherwise.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
 Successfully set the item.
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 caller is not in the correct state (either backup or restore) for the operation.

Remarks

IsSelectedForRestore is relevant only under component mode.

If the component defines a component set, IsSelectedForRestore refers both to the component and all of its subcomponents.

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

IVssBackupComponents::SetSelectedForRestore

IVssComponent