WsGetMessageProperty-Funktion (webservices.h)

  • Artikel

Ruft eine angegebene Message-Objekteigenschaft ab. Die abzurufende Eigenschaft wird durch einen WS_MESSAGE_PROPERTY_ID Eingabeparameter identifiziert.

Syntax

HRESULT WsGetMessageProperty(
  [in]           WS_MESSAGE             *message,
  [in]           WS_MESSAGE_PROPERTY_ID id,
                 void                   *value,
  [in]           ULONG                  valueSize,
  [in, optional] WS_ERROR               *error
);

Parameter

[in] message

Ein Zeiger auf ein Message-Objekt , das die gewünschte Eigenschaft enthält. Dieser Parameter muss ein gültiges WS_LISTENER-Objekt sein.

[in] id

Dies ist ein WS_MESSAGE_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

Die Puffergröße in Bytelänge, 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.
E_OUTOFMEMORY
 Für die Anwendung ist der Arbeitsspeicher nicht mehr vorhanden.
Andere Fehler
Diese Funktion gibt möglicherweise andere Fehler zurück, die oben nicht aufgeführt sind.

Anforderungen

   
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