IViewObject::Freeze メソッド (oleidl.h)

  • [アーティクル]

IViewObject::Unfreeze メソッドが呼び出されるまで変更されないように、オブジェクトの描画表現を固定します。 この方法の最も一般的な用途は、縞模様印刷です。

構文

HRESULT Freeze(
  [in]  DWORD dwDrawAspect,
  [in]  LONG  lindex,
  [in]  void  *pvAspect,
  [out] DWORD *pdwFreeze
);

パラメーター

[in] dwDrawAspect

オブジェクトがどのように表示されるかを指定します。 表現には、コンテンツ、アイコン、サムネイル、または印刷されたドキュメントが含まれます。 有効な値は、列挙 DVASPECT から取得されます。 詳細については、 DVASPECT 列挙を参照してください。

[in] lindex

描画操作の対象となるオブジェクトの一部分。 その解釈は dwAspect によって異なります。 詳細については、 DVASPECT 列挙を参照してください。

[in] pvAspect

dwAspect で指定されたオブジェクトのビューに関する追加情報へのポインター。 現在のいずれの側面も追加情報をサポートしていないため、 pvAspect は常に NULL である必要があります。

[out] pdwFreeze

識別 DWORD キーが返される場所へのポインター。 この一意のキーは、後で IViewObject::Unfreeze を呼び出してフリーズを取り消すために使用されます。 このキーは、どのオブジェクトが固定されているかを追跡するために既定のキャッシュで使用されるインデックスです。

戻り値

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

リターン コード 説明
VIEW_S_ALREADY_FROZEN
 プレゼンテーションは既に固定されています。 pdwFreeze の値は、既に固定されているオブジェクトの識別キーです。
OLE_E_BLANK
 プレゼンテーションがキャッシュにありません。
DV_E_LINDEX
 lindex の値が無効です。現在は;-1 のみがサポートされています。
DV_E_DVASPECT
 dwAspect の値が無効です。

注釈

IViewObject::Freeze メソッドを使用すると、IViewObject::Unfreeze の後続の呼び出しによって解放されるまで、ビュー オブジェクトは描画された表現をフリーズします。 IViewObject::Freeze を呼び出した後、同じパラメーターを使用して IViewObject::D raw を連続して呼び出すと、IViewObject::Unfreeze が呼び出されるまで同じ図が生成されます。

IViewObject::Freeze はオブジェクトの永続的な状態の一部ではなく、オブジェクトのアンロードと再読み込み間で続行されません。

この方法の最も一般的な用途は、縞模様印刷です。

固定状態の間は、ビュー通知は送信されません。 保留中のビュー通知は、 IViewObject::Unfreeze の後続の呼び出しに遅延されます。

要件

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

こちらもご覧ください

DVASPECT

IViewObject

IViewObject::Unfreeze