IMAPIProp::GetPropList

適用対象: Outlook 2013 | Outlook 2016

すべてのプロパティのプロパティ タグを返します。

HRESULT GetPropList(
  ULONG ulFlags,
  LPSPropTagArray FAR * lppPropTagArray
);

パラメーター

ulFlags

[in]返されるプロパティ タグ内の文字列の形式を制御するフラグのビットマスク。 次のフラグを設定できます。

MAPI_UNICODE

返される文字列は Unicode 形式です。 MAPI_UNICODE フラグが設定されていない場合、文字列は ANSI 形式です。

lppPropTagArray

[out]オブジェクトのすべてのプロパティのタグを含むプロパティ タグ配列へのポインターへのポインター。

戻り値

S_OK

すべてのプロパティ タグが正常に返されました。

MAPI_E_BAD_CHARWIDTH

MAPI_UNICODE フラグが設定され、実装で Unicode がサポートされていないか、MAPI_UNICODEが設定されておらず、実装で Unicode のみがサポートされています。

注釈

IMAPIProp::GetPropList メソッドは、オブジェクトで現在サポートされている各プロパティのプロパティ タグを取得します。 オブジェクトが現在プロパティをサポートしていない場合、 GetPropList は cValues メンバーを 0 に設定したプロパティ タグ配列を返します。

GetPropList によって返されるプロパティのスコープは、プロバイダーによって異なります。 一部のサービス プロバイダーは、呼び出し元がアクセスできないプロパティを除外します。 すべてのプロバイダーは、PT_OBJECT型のプロパティ を返します。

オブジェクトが Unicode をサポートしていない場合、 GetPropList は、オブジェクトに対して定義されている文字列プロパティがない場合でも、MAPI_E_BAD_CHARWIDTHを返します。

実装に関するメモ

リモート トランスポート プロバイダーは、ここで指定したとおりに GetPropList を実装します。 特別な懸念はありません。 実装は、当然ながら、 IMAPIProp::GetProps メソッドでサポートされているプロパティの一覧を返す必要があります。

呼び出し側への注意

MAPIFreeBuffer 関数を呼び出して、lppPropTagArray が指すプロパティ タグ配列を解放します。

MFCMAPI リファレンス

MFCMAPI のサンプル コードについては、次の表を参照してください。

ファイル	関数	コメント
MAPIFunctions.cpp	GetPropsNULL	MFCMAPI では、 IMAPIProp::GetPropList メソッドを使用して、 GetProps に渡すプロパティ リストを取得します。

関連項目

IMAPIProp::GetProps
MAPIFreeBuffer
IMAPIProp : コードサンプルとしての IUnknown MFCMAPI