Функция SetupCopyErrorA (setupapi.h)

Статья
11/20/2024

[Эта функция доступна для использования в операционных системах, указанных в разделе "Требования". Он может быть изменен или недоступен в последующих версиях. SetupAPI больше не следует использовать для установки приложений. Вместо этого используйте установщик Windows для разработки установщиков приложений. SetupAPI по-прежнему используется для установки драйверов устройств.]

Функция setupCopyError создает диалоговое окно для уведомления пользователя об ошибке файла копирования.

Синтаксис

WINSETUPAPI UINT SetupCopyErrorA(
  [in]      HWND   hwndParent,
  [in]      PCSTR  DialogTitle,
  [in]      PCSTR  DiskName,
  [in]      PCSTR  PathToSource,
  [in]      PCSTR  SourceFile,
  [in]      PCSTR  TargetPathFile,
  [out]     UINT   Win32ErrorCode,
  [in]      DWORD  Style,
  [in, out] PSTR   PathBuffer,
  [in]      DWORD  PathBufferSize,
  [in, out] PDWORD PathRequiredSize
);

Параметры

[in] hwndParent

Дескриптор родительского окна для этого диалогового окна.

[in] DialogTitle

Необязательный указатель на строку null-terminated, указывающую заголовок диалогового окна.

Этот параметр может быть NULL. Если этот параметр null, используется название по умолчанию "Ошибка копирования" (локализованный на системный язык).

[in] DiskName

Необязательный указатель на строку null-terminated, указывающую имя диска для вставки.

Этот параметр может быть NULL. Если этот параметр значение NULL, используется имя по умолчанию "(Неизвестно)" (локализованное на системный язык).

[in] PathToSource

Указатель на компонент пути исходного файла, в котором операция завершается ошибкой, например F:\x86.

Используйте строку null-terminated.

[in] SourceFile

Указатель на строку null-terminated, указывающую часть имени файла, в которой операция завершается ошибкой.

Используйте строку null-terminated. Это имя файла отображается, если пользователь щелкает кнопки сведений или Обзор. Функция setupCopyError ищет файл, использующий сжатые имена форм. Поэтому вы можете передать cmd.exe и не беспокоиться о том, что файл фактически существует как cmd.ex_ на исходном носителе.

[in] TargetPathFile

Необязательный указатель на строку null-terminated, которая указывает полный путь целевого файла для операций переименования и копирования.

Используйте строку null-terminated. Этот параметр может быть NULL. Если TargetPathFile не указан, используется параметр "(Неизвестно)" (локализованный на системный язык).

[out] Win32ErrorCode

Если возникает ошибка, этот элемент является системным кодом ошибки.

Если ошибка не возникает, это NO_ERROR.

[in] Style

Флаги, управляющие форматированием и поведением диалогового окна.

Этот параметр может быть одним из следующих флагов.

IDF_NOBROWSE

Не отображайте параметр обзора.

IDF_NOSKIP

Не отображайте параметр пропуска файла.

IDF_NODETAILS

Не отображайте параметр сведений.

Если этот флаг задан, параметры TargetPathFile и Win32ErrorCode могут быть опущены.

IDF_NOCOMPRESSED

Не проверяйте сжатые версии исходного файла.

IDF_OEMDISK

Источник операции — это диск, который предоставляет производитель оборудования.

IDF_NOBEEP

Предотвращает отображение диалогового окна, чтобы получить внимание пользователя при первом появлении.

IDF_NOFOREGROUND

Запрещает диалоговое окно стать окном переднего плана.

IDF_WARNIFSKIP

Предупреждает пользователя, что пропуск файла может повлиять на установку.

[in, out] PathBuffer

Необязательный указатель на переменную, в которой эта функция возвращает путь (не включая имя файла) расположения, указанного пользователем в диалоговом окне. Следует использовать строку, завершаемую значением NULL.

Строка null-terminated не должна превышать размер целевого буфера. Чтобы избежать нехватки ошибок буфера, PathBuffer должны быть по крайней мере MAX_PATH. Дополнительные сведения см. в разделе "Примечания" этой статьи.

[in] PathBufferSize

Размер буфера, на который PathBuffer указывает на символы.

Размер буфера должен быть не менее MAX_PATH символов, включая null конца.

[in, out] PathRequiredSize

Необязательный указатель на переменную, в которой эта функция возвращает требуемый размер буфера в символах, включая null конца.

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

Функция возвращает одно из следующих значений.

Чтобы получить расширенные сведения об ошибке, вызовите GetLastError.

Замечания

Если эта функция вызывается с PathBufferNULL и PathBufferSize 0 (ноль), функция помещает размер буфера, необходимый для хранения указанных данных в переменную, на которую указывает PathRequiredSize.

Если функция выполнена успешно, возвращаемое значение NO_ERROR. В противном случае возвращаемое значение является одним из указанных значений.

Чтобы избежать нехватки ошибок буфера, ReturnBuffer должны быть по крайней мере MAX_PATH.

Заметка

Заголовок setupapi.h определяет SetupCopyError как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows XP [только классические приложения]
минимальный поддерживаемый сервер	Windows Server 2003 [только классические приложения]
целевая платформа	Виндоус
заголовка	setupapi.h
библиотеки	Setupapi.lib
DLL	Setupapi.dll

См. также

Обзор

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