Функция GetFileTitleA (commdlg.h)

Статья
11/20/2024

Извлекает имя указанного файла.

Синтаксис

short GetFileTitleA(
  [in]  LPCSTR unnamedParam1,
  [out] LPSTR  Buf,
  [in]  WORD   cchSize
);

Параметры

[in] unnamedParam1

Тип: LPCTSTR

Имя и расположение файла.

[out] Buf

Тип: LPTSTR

Буфер, получающий имя файла.

[in] cchSize

Тип: WORD

Длина буфера в символах, на которую указывает параметр lpszTitle.

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

Тип: короткие

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

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

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

Замечания

GetFileTitle следует вызывать только с юридическими именами файлов; Использование недопустимого имени файла имеет неопределенный результат.

Чтобы получить размер буфера, необходимый для имени файла, вызовите функцию с lpszTitle для NULL и cchSize равным нулю. Функция возвращает требуемый размер.

GetFileTitle возвращает строку, используемую системой для отображения имени файла пользователю. Отображаемое имя включает расширение только в том случае, если это предпочтение пользователя для отображения имен файлов. Это означает, что возвращаемая строка может не точно определить файл, если он используется в вызовах функций файловой системы.

Если буфер lpszTitle слишком мал, GetFileTitle возвращает размер, необходимый для хранения отображаемого имени. Однако между требуемым размером и символами, первоначально указанными в буфере lpsz File, нет гарантированной связи. Например, не вызывайте GetFileTitle с lpszTitle значением NULL и cchSize присвоено нулю, а затем попытайтесь использовать возвращаемое значение в качестве индекса в строке lpszFile. Обычно можно добиться аналогичных результатов (и более высокой производительности) с помощью функций библиотеки времени выполнения C, таких как strrchr, wcsrchrи _mbsrchr.

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	commdlg.h (включая Windows.h)
библиотеки	Comdlg32.lib
DLL	Comdlg32.dll
набор API	ext-ms-win-shell-comdlg32-l1-1-1 (представлено в Windows 10 версии 10.0.14393)

См. также

библиотека общих диалоговых окон

концептуальные

GetOpenFileName

GetSaveFileName

Справочник

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