IVssExamineWriterMetadata::SaveAsXML method (vsbackup.h)

  • Article

The SaveAsXML method saves the Writer Metadata Document that contains a writer's state information to a specified string. This string can be saved as part of a backup operation.

Syntax

HRESULT SaveAsXML(
  [in] BSTR *pbstrXML
);

Parameters

[in] pbstrXML

Pointer to a string to be used to store the Writer Metadata Document that contains a writer's state information.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
 Successfully saved the contents of the XML document in the pbstrXML parameter value.
E_INVALIDARG
 One of the parameter values is not valid.
E_OUTOFMEMORY
 The caller is out of memory or other system resources.
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.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header vsbackup.h (include VsBackup.h, Vss.h, VsWriter.h)
Library VssApi.lib

See also

IVssExamineWriterMetadata

IVssExamineWriterMetadata::LoadFromXML