WS_READ_OPTION列挙 (webservices.h)

値が必要かどうかを指定し、値を割り当てる方法を指定します。

構文

typedef enum {
  WS_READ_REQUIRED_VALUE = 1,
  WS_READ_REQUIRED_POINTER = 2,
  WS_READ_OPTIONAL_POINTER = 3,
  WS_READ_NILLABLE_POINTER = 4,
  WS_READ_NILLABLE_VALUE = 5
} WS_READ_OPTION;

定数

注釈

各 WS_READ_OPTION では、 WS_HEAP オブジェクトを指定する必要がある場合について説明します。 関数によっては、この場合も NULL ヒープ パラメーターを渡すことができます。ヒープ パラメーターが NULL の場合に既定のヒープが使用されるかどうかの詳細については、特定の関数のドキュメントを参照してください。

値をヒープ オブジェクト (WS_HEAP) に逆シリアル化する場合は、次の点を考慮する必要があります。

• 逆シリアル化された値は、ヒープが解放されるまで (WsFreeHeap) またはリセット (WsResetHeap) まで割り当てられたままになります。
• 値が逆シリアル化されるたびに、(既存の値を置き換える代わりに) ヒープに追加されます。
• 逆シリアル化関数中にエラーが発生し、関数が失敗した場合、ヒープ オブジェクトから割り当てられたメモリは、エラーが解放されません。
• ヒープのサイズを使用して、逆シリアル化中に行われる割り当ての合計を制限できます。 ヒープの最大サイズは、次の方法で決定できます。
  • 逆シリアル化中にヒープに割り当てられる各値の最大サイズをバイト単位で決定します。 逆シリアル化されたデータ構造のサイズはプラットフォームによって異なる可能性があることを考慮してください。
  • 各配列は 1 つの値と見なされます。 配列内の項目の実際のサイズは、項目の必要な配置の影響を受ける可能性があることに注意してください。
  • 各値の最大サイズを 16 バイトの境界に丸めます。

要件