Share via


CComControlBase::GetAmbientProperty

Retrieves the container property specified by dispid.

HRESULT GetAmbientProperty( 
   DISPID dispid, 
   VARIANT& var  
);

Parameters

  • dispid
    Identifier of the container property to be retrieved.

  • var
    Variable to receive the property.

Return Value

One of the standard HRESULT values.

Remarks

ATL has provided a set of helper functions to retrieve specific properties, for example, CComControlBase::GetAmbientBackColor. If there is no suitable method available, use GetAmbientProperty.

Requirements

Header: atlctl.h

See Also

Reference

CComControlBase Class