GetFileTitleA-Funktion (commdlg.h)
Ruft den Namen der angegebenen Datei ab.
Syntax
short GetFileTitleA(
[in] LPCSTR unnamedParam1,
[out] LPSTR Buf,
[in] WORD cchSize
);
Parameter
[in] unnamedParam1
Typ: LPCTSTR-
Der Name und Speicherort einer Datei.
[out] Buf
Typ: LPTSTR-
Der Puffer, der den Namen der Datei empfängt.
[in] cchSize
Typ: WORD-
Die Länge des Puffers in Zeichen, auf den der lpszTitle-Parameter verweist.
Rückgabewert
Typ: kurze
Wenn die Funktion erfolgreich ist, ist der Rückgabewert null.
Wenn der Dateiname ungültig ist, ist der Rückgabewert unbekannt. Wenn ein Fehler auftritt, ist der Rückgabewert eine negative Zahl.
Wenn der puffer, auf den der lpszTitle Parameter verweist, zu klein ist, ist der Rückgabewert eine positive ganze Zahl, die die erforderliche Puffergröße in Zeichen angibt. Die erforderliche Puffergröße enthält das endende Nullzeichen.
Bemerkungen
GetFileTitle- sollte nur mit rechtlichen Dateinamen aufgerufen werden; Die Verwendung eines ungültigen Dateinamens hat ein nicht definiertes Ergebnis.
Um die für den Namen einer Datei erforderliche Puffergröße abzurufen, rufen Sie die Funktion mit lpszTitle aufNULL- und cchSize- auf Null festgelegt auf. Die Funktion gibt die erforderliche Größe zurück.
GetFileTitle gibt die Zeichenfolge zurück, die das System zum Anzeigen des Dateinamens für den Benutzer verwenden würde. Der Anzeigename enthält nur dann eine Erweiterung, wenn dies die Einstellung des Benutzers für die Anzeige von Dateinamen ist. Dies bedeutet, dass die zurückgegebene Zeichenfolge die Datei möglicherweise nicht genau identifiziert, wenn sie in Aufrufen von Dateisystemfunktionen verwendet wird.
Wenn der lpszTitle Puffer zu klein ist, gibt GetFileTitle die erforderliche Größe für den Anzeigenamen zurück. Es gibt jedoch keine garantierte Beziehung zwischen der erforderlichen Größe und den ursprünglich im lpszFile Puffer angegebenen Zeichen. Rufen Sie z. B. GetFileTitle- nicht auf, wobei lpszTitle auf NULL- festgelegt ist, und cchSize auf Null festgelegt ist, und versuchen Sie dann, den Rückgabewert als Index in der lpszFile- Zeichenfolge zu verwenden. Sie können in der Regel ähnliche Ergebnisse (und überlegene Leistung) mit C-Laufzeitbibliotheksfunktionen wie strrchr, wcsrchrund _mbsrchrerzielen.
Anmerkung
Der commdlg.h-Header definiert GetFileTitle als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.
Anforderungen
| Anforderung | Wert |
|---|---|
| mindestens unterstützte Client- | Windows 2000 Professional [nur Desktop-Apps] |
| mindestens unterstützte Server- | Windows 2000 Server [nur Desktop-Apps] |
| Zielplattform- | Fenster |
| Header- | commdlg.h (enthalten Windows.h) |
| Library | Comdlg32.lib |
| DLL- | Comdlg32.dll |
| API-Satz | ext-ms-win-shell-comdlg32-l1-1-1 (eingeführt in Windows 10, Version 10.0.14393) |
Siehe auch
allgemeine Dialogfeldbibliothek
Konzeptionelle
Referenz-