IVssExamineWriterMetadataEx2::GetExcludeFromSnapshotFile method (vsbackup.h)
Obtains information about file sets that have been explicitly excluded from a given shadow copy.
Syntax
HRESULT GetExcludeFromSnapshotFile(
[in] UINT iFile,
[out] IVssWMFiledesc **ppFiledesc
);
Parameters
[in] iFile
An index for an excluded file set. The value of this parameter is an integer from 0 to n–1 inclusive, where n is the total number of file sets explicitly excluded from a given shadow copy. The value of n is returned by the IVssExamineWriterMetadataEx2::GetExcludeFromSnapshotCount method.
[out] ppFiledesc
A doubly indirect pointer to an IVssWMFiledesc object containing the file element information.
Return value
The following are the valid return codes for this method.
| Value | Meaning |
|---|---|
|
The pointer to an IVssWMFiledesc interface was successfully returned. |
|
One of the parameter values is not valid. |
|
The caller is out of memory or other system resources. |
|
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 the IUnknown::Release method to release the resources of the returned IVssWMFiledesc object.
The GetExcludeFromSnapshotFile method is intended to report information about file sets excluded from a shadow copy. Requesters should not exclude files from backup based on the information returned by this method.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Target Platform | Windows |
| Header | vsbackup.h (include VsBackup.h, Vss.h, VsWriter.h) |
| Library | VssApi.lib |