WsGetMetadataProperty-Funktion (webservices.h)

  • Artikel

Ruft eine angegebene WS_METADATA-Objekteigenschaft ab. Die abzurufende Eigenschaft wird durch einen WS_METADATA_PROPERTY_ID Eingabeparameter identifiziert.

Hinweis Die von dieser Funktion zurückgegebenen Daten sind gültig, bis das Metadatenobjekt freigegeben oder zurückgesetzt wird. Die Daten sollten nicht geändert werden.
 

Syntax

HRESULT WsGetMetadataProperty(
  [in]           WS_METADATA             *metadata,
  [in]           WS_METADATA_PROPERTY_ID id,
                 void                    *value,
  [in]           ULONG                   valueSize,
  [in, optional] WS_ERROR                *error
);

Parameter

[in] metadata

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

[in] id

Bezeichnerwert der abzurufenden Eigenschaft.

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
 Der Arbeitsspeicher ist 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