CVssWriterEx::GetIdentifyInformation method (vswriter.h)

  • Article

Obtains the metadata that the writer's OnIdentify or OnIdentifyEx method previously reported.

GetIdentifyInformation is a protected method that is implemented by the CVssWriterEx base class.

Syntax

HRESULT GetIdentifyInformation(
  [out] IVssExamineWriterMetadata **ppMetadata
);

Parameters

[out] ppMetadata

A doubly indirect pointer to an IVssExamineWriterMetadata object that contains the returned metadata. Writers must not set the returned pointer to NULL or call IUnknown::Release on it, because the VSS service holds a reference to the object.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
 Successfully returned a pointer to an IVssExamineWriterMetadata object.
E_FAIL
 There was an internal error in the writer.

Remarks

The GetIdentifyInformation method can only be called in a writer's OnPrepareBackup, OnPrepareSnapshot, or OnPostSnapshot method.

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

CVssWriterEx