Метод IVssWMComponent::GetFile (vsbackup.h)

  • Статья

Метод GetFile получает дескриптор файла, связанный с файловой группой.

Синтаксис

HRESULT GetFile(
  [in]  UINT           iFile,
  [out] IVssWMFiledesc **ppFiledesc
);

Параметры

[in] iFile

Смещение от 0 до n-1, где n — это количество файлов в группе файлов, указанное членом cFileCount объекта VSS_COMPONENTINFO , возвращенного IVssWMComponent::GetComponentInfo.

[out] ppFiledesc

Вдвойне косвенный указатель на объект IVssWMFiledesc , содержащий возвращенные сведения дескриптора файла.

Возвращаемое значение

Ниже приведены допустимые коды возврата для этого метода.

Значение Значение
S_OK
 Успешно возвращен указатель на экземпляр интерфейса IVssWMFiledesc .
E_INVALIDARG
 Одно из значений параметра является недопустимым.
E_OUTOFMEMORY
 Вызывающий объект не имеет памяти или других системных ресурсов.
VSS_E_INVALID_XML_DOCUMENT
 Недопустимый XML-документ. Дополнительные сведения см. в журнале событий. Дополнительные сведения см. в разделе Обработка событий и ошибок в VSS.
VSS_E_OBJECT_NOT_FOUND
 Указанный файл не существует.
VSS_E_UNEXPECTED
 Непредвиденная ошибка. Код ошибки регистрируется в файле журнала ошибок. Дополнительные сведения см. в разделе Обработка событий и ошибок в VSS.

Windows Server 2008, Windows Vista, Windows Server 2003 и Windows XP: Это значение не поддерживается до Windows Server 2008 R2 и Windows 7. вместо этого используется E_UNEXPECTED.

Комментарии

Вызывающий объект отвечает за вызов IUnknown::Release для освобождения системных ресурсов, удерживаемых возвращенным объектом IVssWMFiledesc .

Требования

   
Минимальная версия клиента Windows XP [только классические приложения]
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Целевая платформа Windows
Header vsbackup.h (включая VsBackup.h, Vss.h, VsWriter.h)
Библиотека VssApi.lib

См. также раздел

IVssWMComponent