PX_Color

 

Call this function within your control's DoPropExchange member function to serialize or initialize a property of type OLE_COLOR.

Syntax

      BOOL PX_Color(
   CPropExchange* pPX,
   LPCTSTR pszPropName,
   OLE_COLOR& clrValue 
);
BOOL PX_Color(
   CPropExchange* pPX,
   LPCTSTR pszPropName,
   OLE_COLOR& clrValue,
   OLE_COLOR clrDefault 
);

Parameters

  • pPX
    Pointer to the CPropExchange object (typically passed as a parameter to DoPropExchange).

  • pszPropName
    The name of the property being exchanged.

  • clrValue
    Reference to the variable where the property is stored (typically a member variable of your class).

  • clrDefault
    Default value for the property, as defined by the control developer.

Return Value

Nonzero if the exchange was successful; 0 if unsuccessful.

Remarks

The property's value will be read from or written to the variable referenced by clrValue, as appropriate. If clrDefault is specified, it will be used as the property's default value. This value is used if, for any reason, the control's serialization process fails.

Requirements

Header: afxctl.h

See Also

MFC Macros and Globals
COleControl::DoPropExchange