WsCreateHeap 関数 (webservices.h)

ヒープ オブジェクトを作成します。

構文

HRESULT WsCreateHeap(
  [in]           SIZE_T                 maxSize,
  [in]           SIZE_T                 trimSize,
  [in, optional] const WS_HEAP_PROPERTY *properties,
  [in]           ULONG                  propertyCount,
                 WS_HEAP                **heap,
  [in, optional] WS_ERROR               *error
);

パラメーター

[in] maxSize

ヒープから割り当てることができるバイトの合計数。 合計バイト数は、ヒープの作成またはリセット以降に WsAlloc 関数のすべての呼び出しで渡されるサイズの合計として定義されます。

[in] trimSize

WsResetHeap 関数の呼び出しによってヒープがリセットされた後にヒープが保持するメモリの最大バイト数。 これは、ヒープ のオーバーヘッドによる近似値です。

[in, optional] properties

将来の使用のために予約されています。NULL に設定 します。

[in] propertyCount

将来の使用のために予約されています。を 0 (ゼロ) に設定します。

heap

成功した場合、新しいヒープ オブジェクトを表す WS_HEAP 構造体のアドレスを受け取るポインター。

[in, optional] error

関数が失敗した場合に追加のエラー情報を受け取る WS_ERROR 構造体へのポインター。

戻り値

関数が成功すると、NO_ERRORが返されます。それ以外の場合は、HRESULT エラー コードが返されます。

注釈

Windows Web Services API のヒープは、 メッセージに使用されるメモリ割り当てです。 ヒープを使用して、メッセージの有効期間とは別にメッセージ データを格納することもできます。 一部の API 関数では、読み取られたデータの有効期間を明示的にヒープ制御できます。

新しいヒープを作成しても、メモリは割り当てられません ( 構造体自体WS_HEAP 必要なメモリを除きます)。 パラメーター maxSize と trimSize は、WsAlloc 操作と WsResetHeap 操作のみを対象とするクォータとして使用されます。

要件