GetFileTitle

Функция GetFileTitle возвращает имя файла, заданного параметром lpszFile.

короткие ( ) GetFileTitle LPCTSTR  lpszFile, / / указатель полный путь и имя файла для файлаLPTSTRlpszTitle, / / указатель на буфер, получает имя файлаСловоcbBuf / / длина буфера);
 

Параметры

lpszFile

Указатель на имя и местоположение файла.

lpszTitle

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

cbBuf

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

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

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

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

Если параметр lpszTitle буфер слишком мал, возвращаемое значение является положительное целое число, указывающее необходимый размер буфера, в байтах (ANSI-версия) или 16-разрядных символов (Unicode версия). Необходимый размер буфера включает завершающий символ null.

Примечания

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

• Пустая строка
• Строка, содержащая шаблон (**), открыв скобка ([]) или закрывающую квадратную скобку (])
• Строка, которая заканчивается двоеточием (:), Слэш черта (/) или обратной косой черты (\)
• Строка, длина которого превышает длину буфера
• Недопустимый символ (например, пробел или символ нецензурной)

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

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

Если lpszTitle буфер слишком мал, GetFileTitle возвращает размер, необходимого для хранения отображаемое имя. Нет никакой гарантированной связи между требуемого размера и персонажи, первоначально указанных в буфере lpszFile . В переносе 16-битных Windows-приложениям Win32, вам необходимо будет обновить любой код, который основывается на такое поведение в предыдущих версиях системы. Наиболее распространенный случай — это код, который преднамеренно вызывает GetFileTitle с lpszTitle присвоено значение NULL и cbBuf , равным нулю и затем использует значение, возвращаемое как индекс в lpszFile строку. Этот метод больше не поддерживается. Обычно можно добиться подобных результатов (и превосходную производительность) библиотеки времени выполнения таких функций как ( strrchr, wcsrchrи _mbsrchr.

QuickInfo

nbsp; Windows &NT: требует версии 3.1 или более поздней версии.
Windows:Требует Windows 95 или более поздней версии.
Windows CE:Не поддерживается.
Заголовок:Объявленные в commdlg.h.
Импорта библиотеки:Используйте comdlg32.lib.
Юникод:В версии Юникода и ANSI в Windows NT.

Родственные слова

Общие диалогового окна Обзор библиотеки, Общие функции диалогового окна Box, GetOpenFileName, GetSaveFileName

Index