nf-vsbackup-createvssexaminewritermetadatainternal.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:vsbackup.CreateVssExamineWriterMetadataInternal	CreateVssExamineWriterMetadataInternal function (vsbackup.h)	The CreateVssExamineWriterMetadata function (vsbackup.h) creates an IVssExamineWriterMetadata object.	CreateVssExamineWriterMetadata CreateVssExamineWriterMetadata function [VSS] CreateVssExamineWriterMetadataInternal _win32_createvssexaminewritermetadata base.createvssexaminewritermetadata vsbackup/CreateVssExamineWriterMetadata vsbackup/CreateVssExamineWriterMetadataInternal	base\createvssexaminewritermetadata.htm	base	cb322541-d8c0-4a2e-9ce5-453d19ac3fd1	08/09/2022	CreateVssExamineWriterMetadata, CreateVssExamineWriterMetadata function [VSS], CreateVssExamineWriterMetadataInternal, _win32_createvssexaminewritermetadata, base.createvssexaminewritermetadata, vsbackup/CreateVssExamineWriterMetadata, vsbackup/CreateVssExamineWriterMetadataInternal	vsbackup.h	VsBackup.h, Vss.h, VsWriter.h	Windows	Windows XP [desktop apps only]	Windows Server 2003 [desktop apps only]										VssApi.lib	VssApi.dll		Windows			19H1	CreateVssExamineWriterMetadataInternal vsbackup/CreateVssExamineWriterMetadataInternal	c++	APIRef kbSyntax	DllExport	VssApi.dll	CreateVssExamineWriterMetadata CreateVssExamineWriterMetadataInternal

CreateVssExamineWriterMetadataInternal function

-description

The CreateVssExamineWriterMetadata function creates an IVssExamineWriterMetadata object.

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

 

-parameters

-param bstrXML [in]

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

-param ppMetadata [out]

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

-returns

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

Value	Meaning
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.

-see-also

IVssExamineWriterMetadata