IVssWMFiledesc::GetFilespec method (vswriter.h)

  • Article

The GetFilespec method returns the file specification used to obtain the list of files that the current IVssWMFiledesc object is a member of.

A querying method used a path and this file specification to return the current IVssWMFiledesc object.

Syntax

HRESULT GetFilespec(
  [out] BSTR *pbstrFilespec
);

Parameters

[out] pbstrFilespec

The address of a caller-allocated variable that receives a string specifying the returned file specification.

A file specification cannot contain directory specifications (for example, no backslashes) but can contain the ? and * wildcard characters.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
 Successfully returned the filespec information.
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_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

The caller must call SysFreeString to free the memory held by the pbstrFilespec parameter.

Requirements

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

See also

IVssWMFiledesc