На главную

On-line справка по Win32 API

Написать письмо
БЕСПЛАТНАЯ ежедневная online лотерея! Выигрывай каждый день БЕСПЛАТНО!
Список всех статей A-B-C-D-E-F-G-H-I-J-K-L-M-N-O-P-Q-R-S-T-U-V-W-X-Y-Z | Скачать Вниз

GetFileTitle



The GetFileTitle function returns the name of the file identified by the lpszFile parameter.

short GetFileTitle(

LPCTSTR lpszFile, // pointer to full path and filename for file
LPTSTR lpszTitle, // pointer to buffer that receives filename
WORD cbBuf // length of buffer
);


Parameters

lpszFile

Pointer to the name and location of a file.

lpszTitle

Pointer to a buffer into which the function is to copy the name of the file.

cbBuf

Specifies the length, in characters, of the buffer pointed to by the lpszTitle parameter.



Return Values

If the function succeeds, the return value is zero.
If the filename is invalid, the return value is a negative number.
If the buffer pointed to by the lpszTitle parameter is too small, the return value is a positive integer that specifies the required buffer size, in bytes (ANSI version) or characters (Unicode version). The required buffer size includes the terminating null character.

Remarks

The GetFileTitle function returns an error value if the buffer pointed to by the lpszFile parameter contains any of the following elements:

· An empty string
· A string containing a wildcard (*), opening bracket ([), or closing bracket (])
· A string that ends with a colon (:), slash mark (/), or backslash (\)
· A string whose length exceeded the length of the buffer
· An invalid character (for example, a space or an unprintable character)



To get the buffer size needed for the name of a file, call the function with lpszTitle set to NULL and cbBuf set to zero. The function will return the required size.
GetFileTitle returns the string that the system would use to display the filename to the user. The display name includes an extension only if that is the user's preference for displaying filenames. This means that the returned string may not accurately identify the file if it is used in calls to file system functions.

If the lpszTitle buffer is too small, GetFileTitle returns the size required to hold the display name. There is no guaranteed connection between the required size and the characters originally specified in the lpszFile buffer. In porting applications to Windows 95 and Windows NT, developers will need to update any code that relies on such behavior in previous versions of the operating system. The most common case is code that deliberately calls GetFileTitle with lpszTitle set to NULL and cbBuf set to zero, and then uses the return value as an index into the lpszFile string. This technique is no longer supported. You can usually achieve similar results (and superior performance) with run-time library functions such as strrchr, wcsrchr, and _mbsrchr.

See Also

GetOpenFileName, GetSaveFileName


Пригласи друзей и счет твоего мобильника всегда будет положительным!
Предыдущая статья
 
Сайт Народ.Ру Интернет
Следующая статья
Пригласи друзей и счет твоего мобильника всегда будет положительным!

GetFileTitle



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

перемычка GetFileTitle(

LPCTSTR lpszFile, // УКАЗАТЕЛЬ в полный путь и filename для файла LPTSTR lpszTitle, // указателя, чтобы буферизовать эти приемники filename длина WORD cbBuf // буфера
);


Параметры

lpszFile

Указатель в имя и позицию файла.

lpszTitle

Указатель в буфер в который функция должна копировать имя файла.

cbBuf

Определяет длину, в символах, буфера указанного, чтобы параметром lpszTitle.



Обратные Величины

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

Замечания

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

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



Для того, чтобы получать буферный размер необходимый для имени файла, назовите функцию с lpszTitle установленное на НЕДЕЙСТВИТЕЛЬНЫЙ и cbBuf установленный в нуль. Функция возвращает необходимый размер.
GetFileTitle ВОЗВРАЩАЕТ строку, которую система должна использовать, чтобы отображать filename потребителю. Дисплейное имя включает расширение только если это - предпочтение потребителя для отображения filenames. Это означает, что возвращанная строка не может точно идентифицировать файл если использовано на вызовах в файловые системные функции.

Если буфер lpszTitle слишком небольшой, GetFileTitle возвращает размер требовавшийся, чтобы держать дисплейное имя. Нет гарантировать связи между необходимым размером и символы первоначально определялись в буфере lpszFile. В перенесении приложений в Окно 95 и Windows NT, разработчики должны скорректировать любой код, который доверяется в такое поведение в предшествующих версиях операционной системы. Наиболее общий случай является кодом, который умышленно называет GetFileTitle с lpszTitle установленное на НЕДЕЙСТВИТЕЛЬНЫЙ и cbBuf установленный в нуль, затем использует обратную величину как индекс в строку lpszFile. Эта техника больше не поддерживана. Вы можете обычно достичь аналогичных результатов (и высшего исполнения) со временем прогона библиотечных функций как например, strrchr, wcsrchr, и _mbsrchr.

Смотри Также

GetOpenFileName, GetSaveFileName


Вверх Version 1.3, Oct 26 2010 © 2007, 2010, mrhx Вверх
 mrhx software  Русский перевод OpenGL  Русский перевод Win32 API
 
Используются технологии uCoz