IVssBackupComponentsEx2::SetRollForward method (vsbackup.h)

Article
02/22/2024

Sets the roll-forward operation type for a component and specifies the restore point for a partial roll-forward operation.

Syntax

HRESULT SetRollForward(
  [in] VSS_ID               writerId,
  [in] VSS_COMPONENT_TYPE   ct,
  [in] LPCWSTR              wszLogicalPath,
  [in] LPCWSTR              wszComponentName,
  [in] VSS_ROLLFORWARD_TYPE rollType,
  [in] LPCWSTR              wszRollForwardPoint
);

Parameters

[in] writerId

The globally unique identifier (GUID) of the writer class.

[in] ct

The type of the component. See the VSS_COMPONENT_TYPE enumeration for the possible values.

[in] wszLogicalPath

A 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 the string that was used when the component was added.

The logical path can be NULL.

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

[in] wszComponentName

A null-terminated wide character string containing the name of the component.

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

[in] rollType

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

[in] wszRollForwardPoint

A null-terminated wide character string specifying the roll-forward restore point.

The format of this string is defined by the writer, and can be a timestamp, a log sequence number (LSN), or any marker defined by the writer.

Return value

The following are the valid return codes for this method.

Value	Meaning
S_OK	The roll-forward operation type and restore point were successfully set.
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	This method was not called during a restore operation.
VSS_E_OBJECT_NOT_FOUND	The specified component was not found.
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

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

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	vsbackup.h (include VsBackup.h, Vss.h, VsWriter.h)
Library	VssApi.lib