Funzione NPFormatNetworkName (npapi.h)

Articolo
08/25/2023

Formatta un nome di rete in un formato specifico del provider per la visualizzazione in un controllo .

Sintassi

DWORD NPFormatNetworkName(
  [in]      LPWSTR  lpRemoteName,
  [out]     LPWSTR  lpFormattedName,
  [in, out] LPDWORD lpnLength,
  [in]      DWORD   dwFlags,
  [in]      DWORD   dwAveCharPerLine
);

Parametri

[in] lpRemoteName

Puntatore al nome di rete da formattare.

[out] lpFormattedName

Puntatore a una stringa che riceve il nome formattato.

[in, out] lpnLength

Puntatore a DWORD che specifica le dimensioni, in caratteri, del buffer lpFormattedName . Se il valore restituito di questa funzione è WN_MORE_DATA, lpnLength contiene le dimensioni del buffer necessarie, in caratteri.

[in] dwFlags

Campo di bit che indica il tipo di formato richiesto. Questo parametro può avere uno dei valori seguenti.

Valore	Significato
WNFMT_MULTILINE	Il provider deve posizionare la barra rovesciata n (\\n) in cui devono essere visualizzate le interruzioni di riga nel nome. Il nome completo deve essere espresso.
WNFMT_ABBREVIATED	Il provider deve abbreviare il nome di rete in modo che le informazioni più utili per l'utente si adattino allo spazio disponibile.

Inoltre, il flag seguente, che funge da modificatore dei flag precedenti, può essere incluso usando un'operazione OR bit per bit.

Valore	Significato
WNFMT_INENUM	Il nome di rete viene presentato nel contesto di un'enumerazione in cui il nome del "contenitore" viene visualizzato immediatamente prima del nome di rete nell'enumerazione . Ciò consente ai provider di rete di rimuovere le informazioni ridondanti dal nome formattato, fornendo una visualizzazione meno disordinata per l'utente.

[in] dwAveCharPerLine

Specifica il numero medio di caratteri che verranno inclusi in una singola riga in cui viene presentato il nome di rete. In particolare, questo valore viene definito come larghezza del controllo diviso per il campo tmAveCharWidth della struttura TEXTMETRIC del tipo di carattere utilizzato per la visualizzazione nel controllo .

Valore restituito

Se la funzione ha esito positivo, deve restituire WN_SUCCESS.

Se la funzione ha esito negativo, deve restituire il valore seguente. Tutti gli altri errori verranno ignorati e verrà usato il nome di rete non formattato.

Codice restituito	Descrizione
WN_MORE_DATA	Il buffer di input è troppo piccolo.

Commenti

Questa funzione consente ai fornitori di rete di tagliare o modificare i nomi di rete prima che vengano presentati all'utente. Nella finestra di dialogo Apri comune, ad esempio, la casella combinata Unità presenta tutte le risorse connesse e il nome di rete associato. Prima di visualizzare ogni elemento, viene chiamato NPFormatNetworkName e il provider di rete ha la possibilità di modificare il nome in modo che si adatti alla casella combinata. Più importante, il provider di rete può modificare il nome per presentare la parte più significativa del nome di rete all'utente.

Si noti che NPFormatNetworkName non viene instradato a ogni provider di rete, come la maggior parte delle altre funzioni del provider di rete. Ogni fornitore di rete deve preoccuparsi solo della formattazione del proprio nome di rete. Possono presupporre che solo i nomi prodotti dal driver del provider di rete vengano passati a NPFormatNetworkName.

I flag WNFMT_ vengono in genere passati in varie posizioni nell'interfaccia utente, come descritto nella tabella seguente. Non occorre fare ipotesi su quali flag vengono passati; questa tabella viene fornita esclusivamente per aiutare ogni fornitore di rete a decidere il metodo migliore per modificare il nome di rete.

Posizione di visualizzazione	WNFMT_ MULTILINE	WNFMT_ ABBREVIATO	WNFMT_ INENUM
Finestra di dialogo Connessione gestione file, casella combinata Unità , selezione. La sezione di selezione della casella combinata è il rettangolo superiore, sopra la sezione elenco, che visualizza la selezione corrente.		X
Finestra di dialogo Connessione gestione file, casella combinata Unità , elenco. La sezione elenco della casella combinata è la casella di riepilogo visualizzata sotto la parte di selezione della casella combinata.	X
File Manager, elenco Directory condivise .		X	X
Elenco Disconnetti unità di rete di Gestione file.	X
Gestione file, barra degli strumenti, casella combinata, selezione.		X
Gestione file, barra degli strumenti, casella combinata, elenco.	X
Finestre di dialogo Comuni apri e salva , casella combinata Unità , selezione.		X
Finestre di dialogo Comuni apri e salva , casella combinata unità , elenco.		X

Requisiti

Requisito	Valore
Client minimo supportato	Windows XP [solo app desktop]
Server minimo supportato	Windows Server 2003 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	npapi.h

Condividi tramite