COleControl::GetAmbientProperty

Article
03/04/2013

Obtient la valeur d'une propriété ambiante du conteneur.

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

Paramètres

dwDispid
L'identificateur de dispatch de la propriété ambiante souhaitée.
vtProp
Un type variant indicateur qui spécifie le type de la valeur à retourner dans pvProp.

pvProp
Pointeur vers l'adresse de la variable qui reçoit la valeur de propriété ou la valeur de retour.Le type réel de ce pointeur doit correspondre au type spécifié par vtProp.

vtProp	Type de 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*

Valeur de retour

Une valeur différente de zéro si la propriété ambiante en charge ; sinon 0.

Notes

Si vous utilisez GetAmbientProperty pour récupérer les propriétés ambiantes DisplayName et de ScaleUnits, affectez vtProp à VT_BSTR et pvProp à CString*.Si vous récupérez la propriété Font ambiante, affectez vtProp à VT_FONT et pvProp à LPFONTDISP*.

Notez que les fonctions ont déjà été données pour les propriétés ambiantes courantes, telles que AmbientBackColor et AmbientFont.