NPGetPropertyText-Funktion (npapi.h)

Artikel
03/04/2024

Ruft die Namen von Schaltflächen ab, die einem Eigenschaftendialogfeld für eine Netzwerkressource hinzugefügt werden sollen.

Syntax

DWORD NPGetPropertyText(
  [in]      DWORD  iButton,
  [in]      DWORD  nPropSel,
  [in]      LPWSTR lpName,
  [out]     LPWSTR lpButtonName,
  [in, out] DWORD  nButtonNameLen,
  [in]      DWORD  nType
);

Parameter

[in] iButton

Gibt den Index der Schaltfläche an. Der Datei-Manager unterstützt maximal sechs Schaltflächen. Dieser Parameter ist für jede der möglichen Schaltflächen 1 bis 6 nummeriert, wenn nur eine Datei ausgewählt ist, oder 11 bis 16, wenn mehrere Dateien ausgewählt sind.

[in] nPropSel

Gibt an, auf welche Elemente sich das Eigenschaftendialogfeld konzentriert. Dies kann einer der folgenden Werte sein.

Wert	Bedeutung
WNPS_FILE	Eine einzelne Datei.
WNPS_DIR	Ein einzelnes Verzeichnis.
WNPS_MULT	Eine Auswahl mehrerer Dateien, Verzeichnisse oder beides.

[in] lpName

Zeiger auf eine NULL-endende Zeichenfolge, die die Namen des Elements oder der Elemente enthält, die mithilfe des Dialogfelds angezeigt oder bearbeitet werden sollen. Die einzigen unterstützten Elemente sind Dateien und Verzeichnisse, sodass die Elementnamen Dateinamen sind. Diese sollten eindeutig sein, keine Wildcardzeichen enthalten und voll qualifiziert sein (z. B. C:\LOCAL\EXAMPLE.DOC). Mehrere Dateinamen sollten durch Leerzeichen getrennt werden. Ein Dateiname, der Leerzeichen enthält, kann von Anführungszeichen umgeben sein (z. B. "C:\Meine Datei"). In diesem Fall. sie wird als einzelner Name behandelt. Das Caretzeichen '^' kann auch als Anführungsmechanismus für einzelne Zeichen verwendet werden (z. B. C:\My^"File, "C:\My^"File" beziehen sich beide auf die Datei C:\My"File).

[out] lpButtonName

Zeiger auf einen Puffer, in den der Netzwerkanbieter den Namen der Eigenschaftenschaltfläche kopieren soll. Bei Erfolg enthält der Puffer, auf den lpButtonName verweist, den Namen der Eigenschaftenschaltfläche. Wenn dieser Puffer beim Beenden die leere Zeichenfolge enthält, werden die Schaltfläche, die diesem Namen entspricht, und alle erfolgreichen Schaltflächen aus dem Dialogfeld entfernt. Der Netzwerkanbieter kann eine Schaltfläche nicht überspringen.

[in, out] nButtonNameLen

Gibt die Größe des lpButtonName-Puffers in Zeichen an, einschließlich des abschließenden NULL-Zeichens.

[in] nType

Gibt den Elementtyp an, der WNTYPE_FILE werden muss.

Rückgabewert

Wenn die Funktion erfolgreich ist, sollte sie WN_SUCCESS zurückgeben, und lpButtonName kann verwendet werden. Wenn es auf die leere Zeichenfolge zeigt, entspricht keine Schaltfläche einem Index, der so hoch wie iButton ist. Wenn der Rückgabewert nicht WN_SUCCESS ist, sollte der Anbieter auch SetLastError aufrufen, um erweiterte Fehlerinformationen festzulegen. Erweiterte Fehlercodes umfassen Folgendes.

Rückgabecode	Beschreibung
WN_OUT_OF_MEMORY	Die Zeichenfolge konnte nicht aus Ressourcen geladen werden.
WN_MORE_DATA	Der angegebene Puffer ist zu klein für den Text der Schaltfläche.
WN_BAD_VALUE	Der lpName-Parameter ist ein unerwartetes Formular.
WN_NOT_SUPPORTED	Eigenschaftendialogfelder werden für den angegebenen Objekttyp nType nicht unterstützt.

Hinweise

Der Datei-Manager ruft diese Funktion jedes Mal auf, wenn das Eigenschaftendialogfeld aufgerufen wird. Dies geschieht vor dem Anzeigen des Dialogfelds. Wenn der Benutzer auf eine Schaltfläche klickt, die durch diese Funktion vom Netzwerkanbieter hinzugefügt wurde, wird die FUNKTION NPPropertyDialog mit den entsprechenden Parametern aufgerufen.

Nur der Datei-Manager ruft NPGetPropertyText auf und verwendet diese Funktion für Dateien und Verzeichnisse.

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