Skip to content

Latest commit

 

History

History
164 lines (138 loc) · 4.75 KB

nf-vsbackup-ivsswmcomponent-getdatabasefile.md

File metadata and controls

164 lines (138 loc) · 4.75 KB
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.IVssWMComponent.GetDatabaseFile
IVssWMComponent::GetDatabaseFile (vsbackup.h)
The GetDatabaseFile method obtains an IVssWMFiledesc object containing information about the specified database backup component file.
GetDatabaseFile
GetDatabaseFile method [VSS]
GetDatabaseFile method [VSS]
IVssWMComponent interface
IVssWMComponent interface [VSS]
GetDatabaseFile method
IVssWMComponent.GetDatabaseFile
IVssWMComponent::GetDatabaseFile
_win32_ivsswmcomponent_getdatabasefile
base.ivsswmcomponent_getdatabasefile
vsbackup/IVssWMComponent::GetDatabaseFile
base\ivsswmcomponent_getdatabasefile.htm
base
adb2d6f7-592c-403d-92c0-6b99e2180a6b
12/05/2018
GetDatabaseFile, GetDatabaseFile method [VSS], GetDatabaseFile method [VSS],IVssWMComponent interface, IVssWMComponent interface [VSS],GetDatabaseFile method, IVssWMComponent.GetDatabaseFile, IVssWMComponent::GetDatabaseFile, _win32_ivsswmcomponent_getdatabasefile, base.ivsswmcomponent_getdatabasefile, vsbackup/IVssWMComponent::GetDatabaseFile
vsbackup.h
VsBackup.h, Vss.h, VsWriter.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
VssApi.lib
Windows
19H1
IVssWMComponent::GetDatabaseFile
vsbackup/IVssWMComponent::GetDatabaseFile
c++
APIRef
kbSyntax
COM
VssApi.lib
VssApi.dll
IVssWMComponent.GetDatabaseFile

IVssWMComponent::GetDatabaseFile

-description

The GetDatabaseFile method obtains an IVssWMFiledesc object containing information about the specified database backup component file.

-parameters

-param iDBFile [in]

Offset between 0 and n-1, where n is the number of database files as specified by the cDatabases member of the VSS_COMPONENTINFO object returned by IVssWMComponent::GetComponentInfo.

-param ppFiledesc [out]

Doubly indirect pointer to an IVssWMFiledesc object containing the returned file descriptor information.

-returns

The following are the valid return codes for this method.

Value Meaning
S_OK
Successfully returned a pointer to an instance of the IVssWMFiledesc interface.
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 specified database file 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.

-remarks

The caller is responsible for calling IUnknown::Release to release system resources held by the returned IVssWMFiledesc object.

-see-also

IVssWMComponent

IVssWMFiledesc