WsGetChannelProperty-Funktion (webservices.h)

  • Artikel

Ruft eine Eigenschaft des Kanals ab, auf den vom Kanalparameter verwiesen wird.

Syntax

HRESULT WsGetChannelProperty(
  [in]           WS_CHANNEL             *channel,
  [in]           WS_CHANNEL_PROPERTY_ID id,
                 void                   *value,
  [in]           ULONG                  valueSize,
  [in, optional] WS_ERROR               *error
);

Parameter

[in] channel

Ein Zeiger auf das WS_CHANNEL-Objekt mit der abzurufenden Eigenschaft.

[in] id

Stellt einen Bezeichner der abzurufenden Eigenschaft dar.

value

Ein Voidzeiger, der auf den Speicherort zum Speichern der abgerufenen Eigenschaft verweist.

Hinweis Der Zeiger muss über eine Ausrichtung verfügen, die mit dem Typ der Eigenschaft kompatibel ist.

 

[in] valueSize

Die Anzahl der Bytes, die der Aufrufer zum Speichern der abgerufenen Eigenschaft zugewiesen hat.

[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.
E_OUTOFMEMORY
 Der Arbeitsspeicher ist nicht mehr vorhanden.
Andere Fehler
Diese Funktion gibt möglicherweise andere Fehler zurück, die oben nicht aufgeführt sind.

Anforderungen

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