Skip to content

Latest commit

 

History

History
194 lines (134 loc) · 6.55 KB

registry-data-exchange-macros.md

File metadata and controls

194 lines (134 loc) · 6.55 KB
description title ms.date f1_keywords helpviewer_keywords ms.assetid
Learn more about: Registry Data Exchange Macros
Registry Data Exchange Macros
11/04/2016
atlplus/ATL::BEGIN_RDX_MAP
atlplus/ATL::END_RDX_MAP
atlplus/ATL::RDX_BINARY
atlplus/ATL::RDX_CSTRING_TEXT
atlplus/ATL::RDX_DWORD
atlplus/ATL::RDX_TEXT
ATLPLUS/BEGIN_RDX_MAP
ATLPLUS/END_RDX_MAP
ATLPLUS/RDX_BINARY
ATLPLUS/RDX_CSTRING_TEXT
ATLPLUS/RDX_DWORD
ATLPLUS/RDX_TEXT
RegistryDataExchange function, macros
c1bc5e79-2307-43d2-9d10-3a62ffadf473

Registry Data Exchange Macros

These macros perform Registry Data Exchange operations.

Name Description
BEGIN_RDX_MAP Marks the beginning of the Registry Data Exchange map.
END_RDX_MAP Marks the end of the Registry Data Exchange map.
RDX_BINARY Associates the specified registry entry with a specified member variable of type BYTE.
RDX_CSTRING_TEXT Associates the specified registry entry with a specified member variable of type CString.
RDX_DWORD Associates the specified registry entry with a specified member variable of type DWORD.
RDX_TEXT Associates the specified registry entry with a specified member variable of type TCHAR.

Requirements

Header: atlplus.h

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:

Macro Description
RDX_BINARY Associates the specified registry entry with a specified member variable of type BYTE.
RDX_DWORD Associates the specified registry entry with a specified member variable of type DWORD.
RDX_CSTRING_TEXT Associates the specified registry entry with a specified member variable of type CString.
RDX_TEXT Associates the specified registry entry with a specified member variable of type TCHAR.

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