WsGetHeapProperty-Funktion (webservices.h)

Ruft eine bestimmte Eigenschaft eines angegebenen Heaps ab.

Syntax

HRESULT WsGetHeapProperty(
  [in]           WS_HEAP             *heap,
  [in]           WS_HEAP_PROPERTY_ID id,
                 void                *value,
  [in]           ULONG               valueSize,
  [in, optional] WS_ERROR            *error
);

Parameter

[in] heap

Ein Zeiger auf das Heap-Objekt , das die gewünschten Eigenschaftendaten enthält.

[in] id

Dies ist ein WS_HEAP_PROPERTY_ID Enumerator, der die gewünschte Eigenschaft identifiziert.

value

Ein Verweis auf den abgerufenen Eigenschaftswert. Der Zeiger muss über eine Ausrichtung verfügen, die mit dem Typ der Eigenschaft kompatibel ist.

[in] valueSize

Die vom Aufrufer zugewiesene Puffergröße für den abgerufenen Eigenschaftswert.

[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

Wenn diese Funktion erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Anforderungen