NPFormatNetworkName-Funktion (npapi.h)

Formatiert einen Netzwerknamen in einem anbieterspezifischen Format für die Anzeige in einem Steuerelement.

Syntax

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

Die Parameter

[in] lpRemoteName

Zeigen Sie auf den zu formatierenden Netzwerknamen.

[out] lpFormattedName

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

[in, out] lpnLength

Zeiger auf DWORD , der die Größe des lpFormattedName-Puffers 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 einer der folgenden Werte sein:

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

[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 breite des Steuerelements definiert, dividiert durch das TmAveCharWidth-Feld der TEXTMETRIC-Struktur aus der Schriftart, 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 nicht formatierte Netzwerkname wird verwendet.

Bemerkungen

Mit dieser Funktion können Netzwerkanbieter Netzwerknamen kürzen oder ändern, bevor sie dem Benutzer angezeigt werden. Im allgemeinen Dialogfeld " Öffnen " zeigt das Kombinationsfeld "Laufwerke " beispielsweise alle verbundenen Ressourcen und den zugehörigen Netzwerknamen an. Bevor jedes Element angezeigt wird, wird NPFormatNetworkName aufgerufen, und der Netzwerkanbieter hat die Möglichkeit, den Namen so zu bearbeiten, dass es in das Kombinationsfeld passt. Wichtiger ist, dass der Netzwerkanbieter den Namen bearbeiten kann, um dem Benutzer den wichtigsten Teil des Netzwerknamens darzustellen.

Beachten Sie, dass NPFormatNetworkName nicht an jeden Netzwerkanbieter weitergeleitet wird, wie die meisten anderen Netzwerkanbieterfunktionen. Jeder Netzwerkanbieter muss sich nur gedanken über die Formatierung seines eigenen Netzwerknamens machen. 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 auf der Benutzeroberfläche übergeben, wie in der folgenden Tabelle beschrieben. Es sollten keine Annahmen darüber getroffen werden, welche Flags wo weitergegeben werden; Diese Tabelle wird nur bereitgestellt, um jedem Netzwerkanbieter zu helfen, die beste Methode zum Ändern des Netzwerknamens zu bestimmen.

Anforderungen