Funzione GetFileTitleW (commdlg.h)

Recupera il nome del file specificato.

Sintassi

short GetFileTitleW(
  [in]  LPCWSTR unnamedParam1,
  [out] LPWSTR  Buf,
  [in]  WORD    cchSize
);

Parametri

[in] unnamedParam1

Tipo: LPCTSTR

Nome e percorso di un file.

[out] Buf

Tipo: LPTSTR

Buffer che riceve il nome del file.

[in] cchSize

Tipo: WORD

Lunghezza, in caratteri, del buffer a cui punta il parametro lpszTitle .

Valore restituito

Tipo: breve

Se la funzione ha esito positivo, il valore restituito è zero.

Se il nome del file non è valido, il valore restituito è sconosciuto. Se si verifica un errore, il valore restituito è un numero negativo.

Se il buffer puntato al parametro lpszTitle è troppo piccolo, il valore restituito è un intero positivo che specifica le dimensioni del buffer necessarie, in caratteri. Le dimensioni del buffer necessarie includono il carattere Null terminante.

Commenti

GetFileTitle deve essere chiamato solo con nomi di file legali; l'uso di un nome file non valido ha un risultato non definito.

Per ottenere le dimensioni del buffer necessarie per il nome di un file, chiamare la funzione con lpszTitle impostata su NULL e cchSize impostata su zero. La funzione restituisce le dimensioni necessarie.

GetFileTitle restituisce la stringa usata dal sistema per visualizzare il nome del file all'utente. Il nome visualizzato include un'estensione solo se si tratta della preferenza dell'utente per la visualizzazione dei nomi di file. Ciò significa che la stringa restituita potrebbe non identificare in modo accurato il file se viene usato nelle chiamate alle funzioni del file system.

Se il buffer lpszTitle è troppo piccolo, GetFileTitle restituisce le dimensioni necessarie per contenere il nome visualizzato. Tuttavia, non esiste alcuna relazione garantita tra le dimensioni necessarie e i caratteri originariamente specificati nel buffer lpszFile . Ad esempio, non chiamare GetFileTitle con lpszTitle impostato su NULL e cchSize impostato su zero e quindi provare a usare il valore restituito come indice nella stringa lpszFile . In genere è possibile ottenere risultati simili (e prestazioni superiori) con funzioni della libreria di runtime C, ad esempio strrchr, wcsrchr e _mbsrchr.

Requisiti

Vedi anche

Libreria di finestre di dialogo comuni

Informazioni concettuali

Getopenfilename

GetSaveFileName

Riferimento