NPFormatNetworkName-Funktion (npapi.h)

Artikel
08/25/2023

Formatiert einen Netzwerknamen in einem anbieterspezifischen Format zur Anzeige in einem Steuerelement.

Syntax

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

Parameter

[in] lpRemoteName

Zeiger auf den zu formatierenden Netzwerknamen.

[out] lpFormattedName

Zeiger auf eine Zeichenfolge, die den formatierten Namen empfängt.

[in, out] lpnLength

Zeiger auf DWORD , der die Größe des puffers lpFormattedName in Zeichen angibt. Wenn der Rückgabewert dieser Funktion WN_MORE_DATA ist, enthält lpnLength die erforderliche Puffergröße in Zeichen.

[in] dwFlags

Bitfeld, das den Typ des angeforderten Formats angibt. Dieser Parameter kann einen der folgenden Werte annehmen.

Wert	Bedeutung
WNFMT_MULTILINE	Der Anbieter sollte umgekehrten Schrägstrich n (\\n) platzieren, wo Zeilenumbrüche im Namen angezeigt werden sollen. Der vollständige Name sollte angegeben werden.
WNFMT_ABBREVIATED	Der Anbieter sollte den Netzwerknamen kürzen, damit die für den Benutzer nützlichsten Informationen in den verfügbaren Speicherplatz passen.

Darüber hinaus kann das folgende Flag, das als Modifizierer für die vorherigen Flags fungiert, mithilfe eines bitweisen OR-Vorgangs eingeschlossen werden.

Wert	Bedeutung
WNFMT_INENUM	Der Netzwerkname wird im Kontext einer Enumeration angezeigt, in der der Name des "Containers" unmittelbar vor dem Netzwerknamen in der Enumeration angezeigt wird. Dadurch können Netzwerkanbieter redundante Informationen aus dem formatierten Namen entfernen und dem Benutzer eine weniger unübersichtliche Anzeige bieten.

[in] dwAveCharPerLine

Gibt die durchschnittliche Anzahl von Zeichen an, die in eine einzelne Zeile passen, in der der Netzwerkname angezeigt wird. Insbesondere wird dieser Wert als die Breite des Steuerelements definiert, die durch das Feld tmAveCharWidth der TEXTMETRIC-Struktur von der Schriftart geteilt wird, die für die Anzeige im Steuerelement verwendet wird.

Rückgabewert

Wenn die Funktion erfolgreich ist, sollte sie WN_SUCCESS zurückgeben.

Wenn die Funktion fehlschlägt, sollte der folgende Wert zurückgegeben werden. Alle anderen Fehler werden ignoriert, und der unformatierte Netzwerkname wird verwendet.

Rückgabecode	Beschreibung
WN_MORE_DATA	Der Eingabepuffer ist zu klein.

Hinweise

Diese Funktion ermöglicht es Netzwerkanbietern, Netzwerknamen zu kürzen oder zu ändern, bevor sie dem Benutzer angezeigt werden. Im dialogfeld "Allgemeines Öffnen " werden beispielsweise im Kombinationsfeld Laufwerke alle verbundenen Ressourcen und deren zugehörigen Netzwerknamen angezeigt. Bevor jedes Element angezeigt wird, wird NPFormatNetworkName aufgerufen, und der Netzwerkanbieter hat die Möglichkeit, den Namen so zu bearbeiten, dass er in das Kombinationsfeld passt. Wichtiger ist, dass der Netzwerkanbieter den Namen bearbeiten kann, um dem Benutzer den wichtigsten Teil des Netzwerknamens anzuzeigen.

Beachten Sie, dass NPFormatNetworkName nicht wie die meisten anderen Netzwerkanbieterfunktionen an jeden Netzwerkanbieter weitergeleitet wird. Jeder Netzwerkanbieter muss sich nur um die Formatierung seines eigenen Netzwerknamens kümmern. Sie können davon ausgehen, dass nur Namen, die von ihrem Netzwerkanbietertreiber erstellt werden, an NPFormatNetworkName übergeben werden.

Die WNFMT_-Flags werden in der Regel an verschiedenen Stellen in der Benutzeroberfläche übergeben, wie in der folgenden Tabelle beschrieben. Es sollten keine Annahmen darüber getroffen werden, welche Flags wo übergeben werden; Diese Tabelle wird nur bereitgestellt, um jedem Netzwerkanbieter bei der Entscheidung zu helfen, die beste Methode zum Ändern seines Netzwerknamens zu bestimmen.

Anzeigeort	WNFMT_ MULTILINE	WNFMT_ ABGEKÜRZT	WNFMT_ INENUM
Dialogfeld Datei-Manager-Verbindung , Kombinationsfeld Laufwerk , Auswahl. (Der Auswahlabschnitt des Kombinationsfelds ist das obere Rechteck oberhalb des Listenabschnitts, in dem die aktuelle Auswahl angezeigt wird.)		X
Dialogfeld Datei-Manager-Verbindung , Kombinationsfeld Laufwerk , Liste. (Der Listenabschnitt des Kombinationsfelds ist das Listenfeld, das unter dem Auswahlteil des Kombinationsfelds angezeigt wird.)	X
Datei-Manager, Liste freigegebener Verzeichnisse .		X	X
Datei-Manager : Liste Netzwerklaufwerk trennen .	X
Datei-Manager, Symbolleiste, Kombinationsfeld, Auswahl.		X
Datei-Manager, Symbolleiste, Kombinationsfeld, Liste.	X
Allgemeine Dialogfelder Öffnen und Speichern , Kombinationsfeld Laufwerk , Auswahl.		X
Allgemeine Dialogfelder Öffnen und Speichern , Kombinationsfeld Laufwerk , Liste.		X

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	npapi.h

Freigeben über