RegistryDataExchange

 

This function is called to read from, or write to, the system registry.

Important

This function cannot be used in applications that execute in the Windows Runtime.

Syntax

      HRESULT RegistryDataExchange(
T* pT,
enum RDXOperations rdxOp,
void* pItem= NULL 
);

Parameters

  • pT
    A pointer to the current object.

  • rdxOp
    An enum value that indicates which operation the function should perform. See the table in the Remarks section for the allowed values.

  • pItem
    Pointer to the data that is to be read from, or written to, the registry. The data can also represent a key to be deleted from the registry. The default value is NULL.

Return Value

Returns S_OK on success, or an error HRESULT on failure.

Remarks

The macros BEGIN_RDX_MAP and END_RDX_MAP expand to a function that calls RegistryDataExchange.

The possible enum values that indicate the operation the function should perform are shown in the following table:

Enum value

Operation

eReadFromReg

Read data from the registry.

eWriteToReg

Write data to the registry.

eDeleteFromReg

Delete the key from the registry.

See Also

Registry and TypeLib Global Functions
Registry Data Exchange Macros