COleControl::GetAmbientProperty

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

コンテナのアンビエントプロパティの値を取得します。

BOOL GetAmbientProperty(
   DISPID dispid,
   VARTYPE vtProp,
   void* pvProp 
);

パラメータ

dwDispid
要求するアンビエントプロパティのディスパッチ ID。
vtProp
pvProp に返される値の型を示すバリアントの型のタグ。

pvProp
プロパティの値、または戻り値を受け取る変数のアドレスへのポインタ。このポインタの実際の型は、vtProp で指定された型と一致する必要があります。

vtProp	pvProp の型
VT_BOOL	BOOL*
VT_BSTR	CString*
VT_I2	short*
VT_I4	long*
VT_R4	float*
VT_R8	double*
VT_CY	CY*
VT_COLOR	OLE_COLOR*
VT_DISPATCH	LPDISPATCH*
VT_FONT	LPFONTDISP*

戻り値

アンビエントプロパティがサポートされている場合は 0 以外を返します。それ以外の場合は 0 を返します。

解説

アンビエント DisplayName および ScaleUnits プロパティを取得するのに GetAmbientProperty を使うときは、vtProp には VT_BSTR、pvProp には CString* を設定します。アンビエント Font プロパティを取得するときは、vtProp には VT_FONT、pvProp には LPFONTDISP* を設定します。

AmbientBackColor および AmbientFont のようなコモンアンビエントプロパティには、既に関数が用意されています。