Registry Data Exchange Macros

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at Registry Data Exchange Macros.

These macros perform Registry Data Exchange operations.

BEGIN_RDX_MAP

Marks the beginning of the Registry Data Exchange map.

BEGIN_RDX_MAP

Remarks

The following macros are used within the Registry Data Exchange map to read and write entries in the system registry:

The global function RegistryDataExchange, or the member function of the same name created by the BEGIN_RDX_MAP and END_RDX_MAP macros, should be used whenever your code needs to exchange data between the system registry and the variables specified in the RDX map.

END_RDX_MAP

Marks the end of the Registry Data Exchange map.

END_RDX_MAP

RDX_BINARY

Associates the specified registry entry with a specified member variable of type BYTE.

RDX_BINARY(Â
    rootkey, Â
    subkey, Â
    valuename, Â
    member, Â
    member_size Â)

Parameters

rootkey
The registry key root.

subkey
The registry subkey.

valuename
The registry key.

member
The member variable to associate with the specified registry entry.

member_size
The size, in bytes, of the member variable.

Remarks

This macro is used in conjunction with the BEGIN_RDX_MAP and END_RDX_MAP macros to associate a member variable with a given registry entry. The global function RegistryDataExchange, or the member function of the same name created by the BEGIN_RDX_MAP and END_RDX_MAP macros, should be used to perform exchange of data between the system registry and the member variables in the RDX map.

RDX_CSTRING_TEXT

Associates the specified registry entry with a specified member variable of type CString.

RDX_CSTRING_TEXT(Â
    rootkey, Â
    subkey, Â
    valuename, Â
    member, Â
    member_size Â)

Parameters

rootkey
The registry key root.

subkey
The registry subkey.

valuename
The registry key.

member
The member variable to associate with the specified registry entry.

member_size
The size, in bytes, of the member variable.

Remarks

This macro is used in conjunction with the BEGIN_RDX_MAP and END_RDX_MAP macros to associate a member variable with a given registry entry. The global function RegistryDataExchange, or the member function of the same name created by the BEGIN_RDX_MAP and END_RDX_MAP macros, should be used to perform exchange of data between the system registry and the member variables in the RDX map.

RDX_DWORD

Associates the specified registry entry with a specified member variable of type DWORD.

RDX_DWORD(Â
    rootkey, Â
    subkey, Â
    valuename, Â
    member, Â
    member_size Â)

Parameters

rootkey
The registry key root.

subkey
The registry subkey.

valuename
The registry key.

member
The member variable to associate with the specified registry entry.

member_size
The size, in bytes, of the member variable.

Remarks

This macro is used in conjunction with the BEGIN_RDX_MAP and END_RDX_MAP macros to associate a member variable with a given registry entry. The global function RegistryDataExchange, or the member function of the same name created by the BEGIN_RDX_MAP and END_RDX_MAP macros, should be used to perform exchange of data between the system registry and the member variables in the RDX map.

RDX_TEXT

Associates the specified registry entry with a specified member variable of type TCHAR.

RDX_TEXT(Â
    rootkey, Â
    subkey, Â
    valuename, Â
    member, Â
    member_size Â)

Parameters

rootkey
The registry key root.

subkey
The registry subkey.

valuename
The registry key.

member
The member variable to associate with the specified registry entry.

member_size
The size, in bytes, of the member variable.

Remarks

This macro is used in conjunction with the BEGIN_RDX_MAP and END_RDX_MAP macros to associate a member variable with a given registry entry. The global function RegistryDataExchange, or the member function of the same name created by the BEGIN_RDX_MAP and END_RDX_MAP macros, should be used to perform exchange of data between the system registry and the member variables in the RDX map.

See Also

Macros
RegistryDataExchange