IOleUIObjInfoW::GetObjectInfo メソッド (oledlg.h)

  • [アーティクル]

オブジェクトのサイズ、型、名前、および場所の情報を取得します。

構文

HRESULT GetObjectInfo(
  [in]            DWORD  dwObject,
  [out]           DWORD  *lpdwObjSize,
  [out, optional] LPWSTR *lplpszLabel,
  [out, optional] LPWSTR *lplpszType,
  [out, optional] LPWSTR *lplpszShortType,
  [out, optional] LPWSTR *lplpszLocation
);

パラメーター

[in] dwObject

オブジェクトの一意識別子。

[out] lpdwObjSize

ディスク上のオブジェクトのサイズ (バイト単位) へのポインター。 これはおおよその値である可能性があります。

[out, optional] lplpszLabel

オブジェクトのラベル文字列へのポインターを受け取るポインター変数のアドレス。 実装がラベル文字列を返してはならないことを示すには、このパラメーターを NULL にすることができます 。

[out, optional] lplpszType

オブジェクトの長い型文字列へのポインターを受け取るポインター変数のアドレス。 このパラメーターは、実装が長い型文字列を返すべきではないことを示す NULL である 可能性があります。

[out, optional] lplpszShortType

オブジェクトの短い型文字列へのポインターを受け取るポインター変数のアドレス。 実装が短い型の文字列を返さないことを示すために、このパラメーターは NULL にすることができます 。

[out, optional] lplpszLocation

オブジェクトのソース位置文字列へのポインターを受け取るポインター変数のアドレス。 実装が場所の文字列を返すべきではないことを示すために、このパラメーターは NULL である可能性があります。

戻り値

このメソッドは、成功したS_OKを返します。 その他の可能な戻り値は次のとおりです。

リターン コード 説明
E_FAIL
 操作が失敗しました。
E_INVALIDARG
 指定された識別子が無効です。
E_OUTOFMEMORY
 この操作に使用できるメモリが不足しています。

注釈

文字列とオブジェクトのサイズは、オブジェクトのプロパティ [ 全般 ] ページに表示されます。

実装者へのメモ

GetObjectInfo の実装では、指定された out パラメーターに各オブジェクトの属性を配置する必要があります。 オブジェクトのサイズが不明な場合は、 lpdwObjSize を (DWORD)-1 に設定します。 [out] 文字列パラメーターを持つすべての OLE インターフェイスの標準と同様に、 CoGetMalloc を介して取得した OLE タスク アロケーターを使用してすべての文字列 (残りのパラメーター) を割り当てます。または、 単に CoTaskMemAlloc を使用することもできます。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー oledlg.h

こちらもご覧ください

CoGetMalloc

CoTaskMemAlloc

IOleUIObjInfo