IVssCreateExpressWriterMetadata::AddComponentDependency method (vswriter.h)

  • Article

Allows an express writer to indicate that a component it manages has an explicit writer-component dependency; that is, another component (possibly managed by another writer) must be backed up and restored with it.

Syntax

HRESULT AddComponentDependency(
  [in] LPCWSTR wszForLogicalPath,
  [in] LPCWSTR wszForComponentName,
  [in] VSS_ID  onWriterId,
  [in] LPCWSTR wszOnLogicalPath,
  [in] LPCWSTR wszOnComponentName
);

Parameters

[in] wszForLogicalPath

A null-terminated wide character string containing the logical path of the component (managed by the express writer) that requires a dependency.

[in] wszForComponentName

A null-terminated wide character string containing the component (managed by the express writer) that requires a dependency.

[in] onWriterId

A VSS_ID (GUID) value that specifies the writer class of the express writer managing the component on which the current component depends.

[in] wszOnLogicalPath

The logical path of the component (managed by the express writer identified by onWriterId) on which the current component depends.

[in] wszOnComponentName

The name of the component (managed by the express writer identified by onWriterId) on which the current component depends.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
 The operation was successful.
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.
VSS_E_OBJECT_NOT_FOUND
 The component specified by wszForLogicalPath and wszForComponentName does not exist.
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 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header vswriter.h (include Vss.h, VsWriter.h)
Library VssApi.lib

See also

IVssCreateExpressWriterMetadata