Функция GetFileTitle извлекает имя заданного файла.
Синтаксис
short GetFileTitle( LPCTSTR lpszFile, LPTSTR lpszTitle, WORD cbBuf ); |
Параметры
lpszFile
[in] Указатель на имя и расположение файла.lpszTitle
[out] Указатель на буфер, в который функция примет имя файла.cbBuf
[in] Определяет длину буфера, указанного параметром lpszTitle, в символах (TCHARs). Для ANSI версии функции, он определяется в байтах; для Unicode версии - он определяется в символах.Возвращаемые значения
Если функция завершается успешно, возвращаемое значение - нуль.
Если имя файла - недопустимое, возвращаемое значение - неопределенное. Если есть ошибка, возвращаемое значение - отрицательное число.
Если буфер, на который указывает параметр lpszTitle слишком маленький, возвращаемое значение - положительное целое число, которое определяет требуемый размер буфера в символах (TCHARs). Требуемый размер буфера включает в себя символ нуль-терминатора.
Замечания
Функция GetFileTitle должна вызваться только с допустимыми именами файла; использование неправильного имени файла приводит к неизвестному результату. Чтобы получить размер буфера, необходимый для имени файла, вызовите функцию с установленными параметрами lpszTitle к ПУСТО (NULL) и cbBuf в нуль. Функция возвратит необходимый размер.
Функция GetFileTitle возвращает строку, которую система использует, чтобы показать имя файла пользователю. Показываемое имя включает в себя расширение только в том случае, если, это является выбором пользователя для показываемых на экране имен файлов. Это означает, что возвращенная строка не может точно идентифицировать файл, если он используется при обращении к функциям файловой системы.
Если буфер lpszTitle слишком маленький, GetFileTitle возвращает размер, требуемый, чтобы удержать показываемое имя. Однако, нет никакой гарантии согласованности между требуемым размером и символами, первоначально определяемыми в буфере lpszFile. Например, не делайте вызов GetFileTitle с параметром lpszTitle установленным в ПУСТО (NULL) и cbBuf, установленным в нуль, а затем пытаться использовать возвращаемое значение как индекс строки в параметре lpszFile. Вы можете обычно достичь сходных результатов (и лучшей производительности) с библиотечными функциями Си этапа выполнения такими, как strrchr, wcsrchr и _mbsrchr.
Windows 95/98/Me: GetFileTitleW поддерживается программой Microsoft Layer for Unicode (MSLU). Чтобы использовать ее, Вы должны добавить некоторые файлы к вашему приложению, как изложено в описании Microsoft Layer for Unicode для системы Windows 95/98/Me.
Смотри также
Обзор Библиотека стандартных диалоговых окон, Функции, используемые библиотекой стандартных диалоговых окон, GetOpenFileName, GetSaveFileName
|
Размещение и совместимость GetFileTitle |
|
|
Windows. NET Server |
Да |
|
Windows XP |
Да |
|
Windows 2000 |
Да |
|
Windows NT |
Да версии 3.1 и выше |
|
Windows Me |
Да |
|
Windows 98 |
Да |
|
Windows 95 |
Да |
|
Используемая библиотека |
Comdlg32.lib |
|
Заголовочный файл |
|
|
- объявлено в |
Commdlg.h |
|
- включено в |
Windows.h |
|
Unicode |
Нет |
|
Замечания по платформе |
Не имеется |