Метод ITransferAdviseSink::FileFailure (shobjidl_core.h)

Статья
08/26/2023

Вызывается при сбое и необходимости взаимодействия с пользователем.

Синтаксис

HRESULT FileFailure(
  [in]      IShellItem *psi,
  [in]      LPCWSTR    pszItem,
  [in]      HRESULT    hrError,
  [in, out] LPWSTR     pszRename,
  [in]      ULONG      cchRename
);

Параметры

[in] psi

Тип: IShellItem*

Объект IShellItem, в котором произошел сбой операции.

[in] pszItem

Тип: LPCWSTR

Необязательный элемент. Указатель на буфер с пустым завершением, который содержит имя файла. Если это значение равно NULL, используется имя, заданное параметром psi .

[in] hrError

Тип: HRESULT

Код ошибки, сгенерированный ошибкой. Эта ошибка должна быть обработана подсистемой копирования.

[in, out] pszRename

Тип: LPWSTR

Необязательный элемент. При возврате этим методом содержит указатель на буфер, завершающийся значением NULL, который содержит новое имя файла. Имя не может превышать длину cchRename. Если этот параметр имеет значение NULL, параметр переименования не будет доступен.

[in] cchRename

Тип: ULONG

Размер буфера pszRename в символах.

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

Тип: HRESULT

Все остальные hrESULT должны быть возвращены в вызывающий процесс. Если ошибка не обработана, возвращаемое значение должно быть hrError.

Код возврата	Описание
COPYENGINE_S_USER_RETRY	Пользователь нажал кнопку Повторить. Обработчик должен повторить операцию с файлом.
COPYENGINE_E_USERCANCELLED	Пользователь нажал кнопку Отмена. Все задание копирования завершается. Обработчик должен вернуть этот код обратно в подсистему копирования.
COPYENGINE_S_USER_IGNORED	Пользователь нажал Кнопку Пропустить. Обработчик должен пропустить создание элемента и вернуть этот код обратно в подсистему копирования.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	shobjidl_core.h (включая Shobjidl.h)

Поделиться через