IVssComponentEx::GetRollForward method (vswriter.h)

Obtains the roll-forward operation type for a component and obtains the restore point for a partial roll-forward operation.

Syntax

HRESULT GetRollForward(
  [out] VSS_ROLLFORWARD_TYPE *pRollType,
  [out] BSTR                 *pbstrPoint
);

Parameters

[out] pRollType

A VSS_ROLLFORWARD_TYPE enumeration value indicating the type of roll-forward operation to be performed.

[out] pbstrPoint

The address of a caller-allocated variable that receives a null-terminated wide character string specifying the roll-forward restore point.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
The operation was successful.
E_INVALIDARG
One of the parameter values is not valid.
E_OUTOFMEMORY
The caller is out of memory or other system resources.

Remarks

The GetRollForward method can be called only during a restore operation.

If the call to GetRollForward is successful, the caller is responsible for freeing the string that is returned in the pRollType parameter by calling the SysFreeString function.

A writer indicates that it supports this method by setting the VSS_BS_ROLLFORWARD_RESTORE flag in its backup schema mask.

For more information, see Setting VSS Restore Options.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header vswriter.h (include Vss.h, VsWriter.h)
Library VssApi.lib

See also

IVssBackupComponentsEx2::SetRollForward

IVssComponentEx

VSS_BACKUP_SCHEMA

VSS_ROLLFORWARD_TYPE