Функция SetupCopyErrorA (setupapi.h)
[Эта функция доступна для использования в операционных системах, указанных в разделе Требования. В последующих версиях он может быть изменен или недоступен. 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. Если этот параметр имеет значение NULL, используется заголовок по умолчанию "Ошибка копирования" (локализованный на системный язык).
[in] DiskName
Необязательный указатель на строку, завершающуюся значением NULL, которая указывает имя вставляемого диска.
Этот параметр может принимать значение NULL. Если этот параметр имеет значение NULL, используется имя по умолчанию (Неизвестно)" (локализованное на системный язык).
[in] PathToSource
Указатель на компонент пути исходного файла, в котором происходит сбой операции, например F:\x86.
Используйте строку, завершаемую null.
[in] SourceFile
Указатель на строку, завершающуюся значением NULL, которая указывает часть файла с именем файла, в которой происходит сбой операции.
Используйте строку, завершаемую null. Это имя файла отображается, если пользователь нажимает кнопки Сведения или Обзор . Функция SetupCopyError ищет файл, использующий сжатые имена форм. Таким образом, вы можете передать cmd.exe и не беспокоиться о том, что файл на самом деле существует как cmd.ex_ на исходном носителе.
[in] TargetPathFile
Необязательный указатель на строку, завершающуюся значением NULL, которая указывает полный путь к целевому файлу для операций переименования и копирования.
Используйте строку, завершаемую null. Этот параметр может принимать значение NULL. Если targetPathFile не указан, используется "(Unknown)" (локализованный на системный язык).
[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, не должна превышать размер буфера назначения. Чтобы избежать ошибок недостаточного буфера, PathBuffer должен быть по крайней мере MAX_PATH. Дополнительные сведения см. в разделе Примечания этой статьи.
[in] PathBufferSize
Размер буфера, на который указывает PathBuffer , в символах.
Размер буфера должен быть не менее MAX_PATH символов, включая признак конца null .
[in, out] PathRequiredSize
Необязательный указатель на переменную, в которой эта функция возвращает требуемый размер буфера в символах, включая признак конца null .
Возвращаемое значение
Функция возвращает одно из следующих значений.
Дополнительные сведения об ошибке можно получить, вызвав GetLastError.
Комментарии
Если эта функция вызывается с PathBufferсо значением NULL и Значением PathBufferSize 0 (ноль), функция помещает размер буфера, необходимый для хранения указанных данных, в переменную, на которую указывает PathRequiredSize.
Если функция выполнена успешно, возвращаемое значение будет NO_ERROR. В противном случае возвращаемое значение является одним из указанных значений.
Чтобы избежать ошибок недостаточного буфера, Значение ReturnBuffer должно быть по крайней мере MAX_PATH.
Примечание
Заголовок setupapi.h определяет SetupCopyError в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Windows XP [только классические приложения] |
| Минимальная версия сервера | Windows Server 2003 [только классические приложения] |
| Целевая платформа | Windows |
| Header | setupapi.h |
| Библиотека | Setupapi.lib |
| DLL | Setupapi.dll |