GetFileTitle

GetFileTitle返回由IpszFile參數標識的檔案名稱。

基本介紹

• 中文名：GetFileTitle
• 功能：返回由IpszFile參數標識的檔案名稱
• 原型：short GetFileTitle
• 參數：IpszFile,IpszTitle,chBuf

函式原型

short GetFileTitle( LPCTSTR lpszFile, LPTSTR lpszTitle, WORD cbBuf);

參數

IpszFile：指向一個檔案名稱或檔案位置的指針。

IpszTitle：指向一個緩衝區，在此緩衝區中函式複製檔案名稱。

chBuf：指定由IpszTitle函式指向的緩衝的位元組長度。

返回值

如果函式調用成功，返回值為零；如果檔案名稱無效，返回值為一負值。如果由IpszTitle參數指向的緩衝區的太小，返回值為一正整數，其值指定了所需緩衝區的大小。所需緩衝區的大小還包括結尾的NULL字元。

備註

如果由IpszFile參數指向的緩衝區包含下列任何一個成員，GetFileTitle函式返回一個錯誤信息值。

一個空字元串；一個含有星號（）、開括弧（[）、閉方括弧（]）的串、一個以冒號（：）、斜槓（/）或倒斜槓結尾的串；一個長度超過緩衝區長度的串；一個無效字元（如，一個空格或一個不能列印的字母）：為得到檔案名稱所需的緩衝區的大小，用設定為NULL的IpszTitle和設定為零的cbBuf調用函式。函式將返回所需的大小。

GetFileTitle函式返回一個串，系統套用此串為用戶顯示檔案名稱。這就意味著如果返回串套用在檔案系統函式的調用中不可能準確地標識檔案。

如果證IpszTitle緩衝區太小，GetFile Title返回的大小需要含有顯示名。在IpszFile緩衝區指定的需要的大小和字元之間沒有許可的聯繫。

速查

Windows NT：3.1及以上版本：Windows：95及以上版本：Windows CE：不支持：頭檔案：Commdlg.h；庫檔案：comdlg32.lib；Unicode：在Windows NT環境中實現為Unicode和ANSI兩個版本。