Edit

Dialog Data Exchange Functions for OLE Controls

  • Article

This topic lists the DDX_OC functions used to exchange data between a property of an OLE control in a dialog box, form view, or control view object and a data member of the dialog box, form view, or control view object.

DDX_OC Functions

Name Description
DDX_OCBool Manages the transfer of BOOL data between a property of an OLE control and a BOOL data member.
DDX_OCBoolRO Manages the transfer of BOOL data between a read-only property of an OLE control and a BOOL data member.
DDX_OCColor Manages the transfer of OLE_COLOR data between a property of an OLE control and an OLE_COLOR data member.
DDX_OCColorRO Manages the transfer of OLE_COLOR data between a read-only property of an OLE control and an OLE_COLOR data member.
DDX_OCFloat Manages the transfer of float (or double) data between a property of an OLE control and a float (or double) data member.
DDX_OCFloatRO Manages the transfer of float (or double) data between a read-only property of an OLE control and a float (or double) data member.
DDX_OCInt Manages the transfer of int (or long) data between a property of an OLE control and an int (or long) data member.
DDX_OCIntRO Manages the transfer of int (or long) data between a read-only property of an OLE control and an int (or long) data member.
DDX_OCShort Manages the transfer of short data between a property of an OLE control and a short data member.
DDX_OCShortRO Manages the transfer of short data between a read-only property of an OLE control and a short data member.
DDX_OCText Manages the transfer of CString data between a property of an OLE control and a CString data member.
DDX_OCTextRO Manages the transfer of CString data between a read-only property of an OLE control and a CString data member.

DDX_OCBool

The DDX_OCBool function manages the transfer of BOOL data between a property of an OLE control in a dialog box, form view, or control view object and a BOOL data member of the dialog box, form view, or control view object.

void AFXAPI DDX_OCBool(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    BOOL& value);

Parameters

pDX
A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC
The ID of an OLE control in the dialog box, form view, or control view object.

dispid
The dispatch ID of a property of the control.

value
A reference to a member variable of the dialog box, form view or control view object with which data is exchanged.

Remarks

For more information about DDX, see Dialog Data Exchange and Validation.

Requirements

Header: afxdisp.h

DDX_OCBoolRO

The DDX_OCBoolRO function manages the transfer of BOOL data between a read-only property of an OLE control in a dialog box, form view, or control view object and a BOOL data member of the dialog box, form view, or control view object.

void AFXAPI DDX_OCBoolRO(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    BOOL& value);

Parameters

pDX
A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC
The ID of an OLE control in the dialog box, form view, or control view object.

dispid
The dispatch ID of a property of the control.

value
A reference to a member variable of the dialog box, form view or control view object with which data is exchanged.

Remarks

For more information about DDX, see Dialog Data Exchange and Validation.

Requirements

Header afxdisp.h

DDX_OCColor

The DDX_OCColor function manages the transfer of OLE_COLOR data between a property of an OLE control in a dialog box, form view, or control view object and a OLE_COLOR data member of the dialog box, form view, or control view object.

void AFXAPI DDX_OCColor(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    OLE_COLOR& value);

Parameters

pDX
A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC
The ID of an OLE control in the dialog box, form view, or control view object.

dispid
The dispatch ID of a property of the control.

value
A reference to a member variable of the dialog box, form view or control view object with which data is exchanged.

Remarks

For more information about DDX, see Dialog Data Exchange and Validation.

Requirements

Header afxdisp.h

DDX_OCColorRO

The DDX_OCColorRO function manages the transfer of OLE_COLOR data between a read-only property of an OLE control in a dialog box, form view, or control view object and a OLE_COLOR data member of the dialog box, form view, or control view object.

void AFXAPI DDX_OCColorRO(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    OLE_COLOR& value);

Parameters

pDX
A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC
The ID of an OLE control in the dialog box, form view, or control view object.

dispid
The dispatch ID of a property of the control.

value
A reference to a member variable of the dialog box, form view or control view object with which data is exchanged.

Remarks

For more information about DDX, see Dialog Data Exchange and Validation.

Requirements

Header afxdisp.h

DDX_OCFloat

The DDX_OCFloat function manages the transfer of float (or double) data between a property of an OLE control in a dialog box, form view, or control view object and a float (or double) data member of the dialog box, form view, or control view object.

void AFXAPI DDX_OCFloat(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    float& value);

void AFXAPI DDX_OCFloat(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    double& value);

Parameters

pDX
A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC
The ID of an OLE control in the dialog box, form view, or control view object.

dispid
The dispatch ID of a property of the control.

value
A reference to a member variable of the dialog box, form view or control view object with which data is exchanged.

Remarks

For more information about DDX, see Dialog Data Exchange and Validation.

Requirements

Header afxdisp.h

DDX_OCFloatRO

The DDX_OCFloatRO function manages the transfer of float (or double) data between a read-only property of an OLE control in a dialog box, form view, or control view object and a float (or double) data member of the dialog box, form view, or control view object.

void AFXAPI DDX_OCFloatRO(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    float& value);

void AFXAPI DDX_OCFloatRO(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    double& value);

Parameters

pDX
A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC
The ID of an OLE control in the dialog box, form view, or control view object.

dispid
The dispatch ID of a property of the control.

value
A reference to a member variable of the dialog box, form view or control view object with which data is exchanged.

Remarks

For more information about DDX, see Dialog Data Exchange and Validation.

Requirements

Header afxdisp.h

DDX_OCInt

The DDX_OCInt function manages the transfer of int (or long) data between a property of an OLE control in a dialog box, form view, or control view object and an int (or long) data member of the dialog box, form view, or control view object.

void AFXAPI DDX_OCInt(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    int& value);

void AFXAPI DDX_OCInt(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    long& value);

Parameters

pDX
A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC
The ID of an OLE control in the dialog box, form view, or control view object.

dispid
The dispatch ID of a property of the control.

value
A reference to a member variable of the dialog box, form view or control view object with which data is exchanged.

Remarks

For more information about DDX, see Dialog Data Exchange and Validation.

Requirements

Header afxdisp.h

DDX_OCIntRO

The DDX_OCIntRO function manages the transfer of int (or long) data between a read-only property of an OLE control in a dialog box, form view, or control view object and a int (or long) data member of the dialog box, form view, or control view object.

void AFXAPI DDX_OCIntRO(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    int& value);

void AFXAPI DDX_OCIntRO(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    long& value);

Parameters

pDX
A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC
The ID of an OLE control in the dialog box, form view, or control view object.

dispid
The dispatch ID of a property of the control.

value
A reference to a member variable of the dialog box, form view or control view object with which data is exchanged.

Remarks

For more information about DDX, see Dialog Data Exchange and Validation.

Requirements

Header afxdisp.h

DDX_OCShort

The DDX_OCShort function manages the transfer of short data between a property of an OLE control in a dialog box, form view, or control view object and a short data member of the dialog box, form view, or control view object.

void AFXAPI DDX_OCShort(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    short& value);

Parameters

pDX
A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC
The ID of an OLE control in the dialog box, form view, or control view object.

dispid
The dispatch ID of a property of the control.

value
A reference to a member variable of the dialog box, form view or control view object with which data is exchanged.

Remarks

For more information about DDX, see Dialog Data Exchange and Validation.

Requirements

Header afxdisp.h

DDX_OCShortRO

The DDX_OCShortRO function manages the transfer of short data between a read-only property of an OLE control in a dialog box, form view, or control view object and a short data member of the dialog box, form view, or control view object.

void AFXAPI DDX_OCShortRO(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    short& value);

Parameters

pDX
A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC
The ID of an OLE control in the dialog box, form view, or control view object.

dispid
The dispatch ID of a property of the control.

value
A reference to a member variable of the dialog box, form view or control view object with which data is exchanged.

Remarks

For more information about DDX, see Dialog Data Exchange and Validation.

Requirements

Header afxdisp.h

DDX_OCText

The DDX_OCText function manages the transfer of CString data between a property of an OLE control in a dialog box, form view, or control view object and a CString data member of the dialog box, form view, or control view object.

void AFXAPI DDX_OCText(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    CString& value);

Parameters

pDX
A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC
The ID of an OLE control in the dialog box, form view, or control view object.

dispid
The dispatch ID of a property of the control.

value
A reference to a member variable of the dialog box, form view or control view object with which data is exchanged.

Remarks

For more information about DDX, see Dialog Data Exchange and Validation.

Requirements

Header afxdisp.h

DDX_OCTextRO

The DDX_OCTextRO function manages the transfer of CString data between a read-only property of an OLE control in a dialog box, form view, or control view object and a CString data member of the dialog box, form view, or control view object.

void AFXAPI DDX_OCTextRO(
    CDataExchange* pDX,
    int nIDC,
    DISPID dispid,
    CString& value);

Parameters

pDX
A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC
The ID of an OLE control in the dialog box, form view, or control view object.

dispid
The dispatch ID of a property of the control.

value
A reference to a member variable of the dialog box, form view or control view object with which data is exchanged.

Remarks

For more information about DDX, see Dialog Data Exchange and Validation.

Requirements

Header afxdisp.h

See also

Macros and Globals