IVssComponent::GetBackupStamp method (vswriter.h)

Article
10/13/2021

The GetBackupStamp method returns the backup stamp string stored by a writer for a given component.

Either a writer or a requester can call this method.

Syntax

HRESULT GetBackupStamp(
  [out] BSTR *pbstrBackupStamp
);

Parameters

[out] pbstrBackupStamp

The address of a caller-allocated variable that receives a string containing the backup stamp indicating the time at which the component was backed up.

Return value

The following are the valid return codes for this method.

Value	Meaning
S_OK	Successfully returned the attribute value.
S_FALSE	There is no time stamp associated with this component.
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.

Remarks

If no backup time stamp has been set, GetBackupStamp returns S_FALSE.

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

The string returned refers to all files in the component and any nonselectable subcomponents it has.

The backup stamp retrieved by GetBackupStamp is generally set by a writer by a call to IVssComponent::SetBackupStamp from within the PostSnapshot event handler, CVssWriter::OnPostSnapshot.

Requesters merely store the backup stamps in the Backup Components Document; they do not make direct use of the backup stamp, know how to generate it, or understand its format.

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