CreateVssExamineWriterMetadata function

The CreateVssExamineWriterMetadata function creates an IVssExamineWriterMetadata object.

Note  This function is exported as CreateVssExamineWriterMetadataInternal, but you should call CreateVssExamineWriterMetadata, not CreateVssExamineWriterMetadataInternal.

Syntax


HRESULT CreateVssExamineWriterMetadata(
  _In_   BSTR bstrXML,
  _Out_  IVssExamineWriterMetadata **ppMetadata
);

Parameters

bstrXML [in]

An XML string containing a Writer Metadata Document with which to initialize the returned IVssExamineWriterMetadata object.

ppMetadata [out]

A variable that receives an IVssExamineWriterMetadata interface pointer to the object.

Return value

The return values listed here are in addition to the normal COM HRESULTs that may be returned at any time from the function.

ValueMeaning
S_OK

Successfully returned a pointer to an IVssExamineWriterMetadata interface.

E_ACCESSDENIED

The caller does not have sufficient backup privileges or is not an administrator.

E_INVALIDARG

One of the parameters is not valid.

E_OUTOFMEMORY

Out of memory or other system resources.

VSS_E_INVALID_XML_DOCUMENT

The XML document passed in the bstrXML parameter is not valid—that is, either it is not a correctly formed XML string or it does not match the schema.

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

To save a copy of a writer’s Writer Metadata Document into an XML string to pass in the bstrXML parameter, use the IVssExamineWriterMetadata::SaveAsXML method.

To retrieve the latest version of a writer’s Writer Metadata Document, use the IVssBackupComponents::GetWriterMetadata method.

To load a writer metadata document into an existing IVssExamineWriterMetadata object, use the IVssExamineWriterMetadata::LoadFromXML method.

Users should not attempt to modify the contents of the Writer Metadata Document.

The calling application is responsible for calling IUnknown::Release to release the resources held by the IVssExamineWriterMetadata object when the object is no longer needed.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

VsBackup.h (include VsBackup.h, Vss.h, or VsWriter.h)

Library

VssApi.lib

DLL

VssApi.dll

See also

IVssExamineWriterMetadata

 

 

Community Additions

ADD
Show:
© 2014 Microsoft