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

Статья
11/20/2024

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

Функция SetupGetTargetPath определяет целевой каталог для раздела списка файлов. Раздел списка файлов может быть разделом копирования файлов, разделом удаления файлов или разделом переименование файлов. Все файлы в разделе должны находиться в одном каталоге, указанном в разделе DestinationDirs INF-файла.

Синтаксис

WINSETUPAPI BOOL SetupGetTargetPathA(
  [in]      HINF        InfHandle,
  [in]      PINFCONTEXT InfContext,
  [in]      PCSTR       Section,
  [in, out] PSTR        ReturnBuffer,
  [in]      DWORD       ReturnBufferSize,
  [in, out] PDWORD      RequiredSize
);

Параметры

[in] InfHandle

Обработайте файл INF загрузки, содержащий раздел DestinationDirs.

[in] InfContext

Необязательный указатель на контекст INF, указывающий строку в разделе списка файлов, целевой каталог которого требуется извлечь. Если InfContext значение NULL, используется параметр раздела .

[in] Section

Необязательный параметр, указывающий имя раздела INF-файла, дескриптор которого InfHandle. SetupGetTargetPath извлекает целевой каталог для этого раздела. Параметр раздела игнорируется, если указан InfContext. Если ни InfContext, ни раздел не указан, функция извлекает целевой путь по умолчанию из INF-файла. Следует использовать строку null-terminated.

[in, out] ReturnBuffer

Необязательный указатель на буфер для получения полного целевого пути. Путь гарантированно не заканчивается. Следует использовать строку null-terminated. Вы можете вызвать функцию один раз, чтобы получить необходимый размер буфера, выделить необходимую память, а затем вызвать функцию во второй раз, чтобы получить данные. С помощью этого метода можно избежать ошибок из-за недостаточного размера буфера. См. раздел "Примечания". Этот параметр может быть NULL.

[in] ReturnBufferSize

Размер буфера, на который указывает ReturnBuffer, в символах. Это включает в себя null конца.

[in, out] RequiredSize

Необязательный указатель на переменную, которая получает требуемый размер буфера, на который указывает ReturnBuffer, в символах. Это включает в себя null конца. Если фактический размер превышает значение, указанное ReturnBufferSize, функция завершается ошибкой и вызовом GetLastError возвращается ERROR_INSUFFICIENT_BUFFER.

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

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

Если функция завершается ошибкой, возвращаемое значение равно нулю. Чтобы получить расширенные сведения об ошибке, вызовите GetLastError.

Замечания

Если эта функция вызывается с ReturnBufferNULL и ReturnBufferSize нуля, функция помещает размер буфера, необходимый для хранения указанных данных в переменную, на которую указывает RequiredSize. Если функция выполнена успешно, возвращаемое значение ненулевое значение. В противном случае возвращаемое значение равно нулю и расширенным сведениям об ошибке можно получить путем вызова GetLastError.

Заметка

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

Требования

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

См. также

Функции

Обзор

SetupGetSourceFileLocation

SetupGetSourceFileSize

SetupGetSourceInfo

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