WsGetListenerProperty-Funktion (webservices.h)

Ruft eine angegebene Listener-Objekteigenschaft ab. Die abzurufende Eigenschaft wird durch einen WS_LISTENER_PROPERTY_ID Eingabeparameter identifiziert.

Syntax

HRESULT WsGetListenerProperty(
  [in]           WS_LISTENER             *listener,
  [in]           WS_LISTENER_PROPERTY_ID id,
                 void                    *value,
  [in]           ULONG                   valueSize,
  [in, optional] WS_ERROR                *error
);

Parameter

[in] listener

Ein Zeiger auf das Listener-Objekt, das die gewünschte Eigenschaft enthält. Dies muss eine gültige WS_LISTENER sein, die von WsCreateListener zurückgegeben wurde.

[in] id

Dies ist ein WS_LISTENER_PROPERTY_ID Enumeratorwert, der die gewünschte Eigenschaft identifiziert.

value

Ein Verweis auf einen Speicherort zum Speichern des abgerufenen Eigenschaftswerts. Der Zeiger muss über eine Ausrichtung verfügen, die mit dem Typ der Eigenschaft kompatibel ist.

[in] valueSize

Stellt die Puffergröße in Bytelänge dar, die vom Aufrufer zum Speichern des abgerufenen Eigenschaftswerts zugewiesen wird.

[in, optional] error

Ein Zeiger auf ein WS_ERROR-Objekt , in dem zusätzliche Informationen zum Fehler gespeichert werden sollen, wenn die Funktion fehlschlägt.

Rückgabewert

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode Beschreibung
E_INVALIDARG
Die Eigenschafts-ID wurde für dieses Objekt nicht unterstützt, oder der angegebene Puffer war nicht groß genug für den Wert.
Andere Fehler
Diese Funktion gibt möglicherweise andere Fehler zurück, die oben nicht aufgeführt sind.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows 7 [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 R2 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile webservices.h
Bibliothek WebServices.lib
DLL WebServices.dll