src/CustomActions/SystemTools/RegistryImpl.cpp File Reference

#include "StdAfx.h"
#include "FlagMaps.h"
#include "RegistryImpl.h"

Functions
CA_API UINT __stdcall	Registry_CopyBranch (MSIHANDLE hInstall)
	Copy a full registry branch.
CA_API UINT __stdcall	Registry_MoveBranch (MSIHANDLE hInstall)
	Move a full registry branch.
CA_API UINT __stdcall	Registry_DeleteBranch (MSIHANDLE hInstall)
	Delete a full registry branch.
CA_API UINT __stdcall	Registry_CreateKey (MSIHANDLE hInstall)
	Creates a registry key.
CA_API UINT __stdcall	Registry_SetStringValue (MSIHANDLE hInstall)
	Delete a full registry branch.
CA_API UINT __stdcall	Registry_KeyExists (MSIHANDLE hInstall)
	Check if a registry key exists.
CA_API UINT __stdcall	Win32_RegistryCopy_Immediate (MSIHANDLE hInstall)
	Copy registry keys. This is a table-driven custom action. Use in combination with AppSecInc::Wix::Extensions::SystemToolsExtension.
CA_API UINT __stdcall	Win32_RegistryCopy_Deferred (MSIHANDLE hInstall)

---

Function Documentation

CA_API UINT __stdcall Registry_CopyBranch

(

MSIHANDLE

hInstall

)

Copy a full registry branch.

Parameters:

REGISTRY_ROOT	One of HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER, etc
REGISTRY_PATH_SOURCE	A registry path under REGISTRY_ROOT to copy from
REGISTRY_ROOT_TARGET	An optional registry target, one of HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER, etc.
REGISTRY_PATH_TARGET	A registry path under REGISTRY_ROOT to copy to

Returns:

check CA_ERROR on function failure

CA_API UINT __stdcall Registry_CreateKey

(

MSIHANDLE

hInstall

)

Creates a registry key.

Parameters:

REGISTRY_ROOT	One of HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER, etc
REGISTRY_PATH	A registry path under REGISTRY_ROOT that has to be created

Returns:

check CA_ERROR on function failure

CA_API UINT __stdcall Registry_DeleteBranch

(

MSIHANDLE

hInstall

)

Delete a full registry branch.

Parameters:

REGISTRY_ROOT	One of HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER, etc
REGISTRY_PATH	A registry path under REGISTRY_ROOT to delete

Returns:

check CA_ERROR on function failure

CA_API UINT __stdcall Registry_KeyExists

(

MSIHANDLE

hInstall

)

Check if a registry key exists.

Parameters:

REGISTRY_ROOT	One of HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER, etc
REGISTRY_PATH	A registry path under REGISTRY_ROOT
REGISTRY_NAME	Name. Set it to an empty value for checking only the key.

Returns:

check CA_ERROR on function failure

CA_API UINT __stdcall Registry_MoveBranch

(

MSIHANDLE

hInstall

)

Move a full registry branch.

Parameters:

REGISTRY_ROOT	One of HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER, etc
REGISTRY_PATH_SOURCE	A registry path under REGISTRY_ROOT to move from
REGISTRY_ROOT_TARGET	An optional registry target, one of HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER, etc.
REGISTRY_PATH_TARGET	A registry path under REGISTRY_ROOT to move to

Returns:

check CA_ERROR on function failure

CA_API UINT __stdcall Registry_SetStringValue

(

MSIHANDLE

hInstall

)

Delete a full registry branch.

Parameters:

REGISTRY_ROOT	One of HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER, etc
REGISTRY_PATH	A registry path under REGISTRY_ROOT where the name has to be set
REGISTRY_NAME	The name for which the value has to be set
REGISTRY_VALUE	The value

Returns:

check CA_ERROR on function failure

CA_API UINT __stdcall Win32_RegistryCopy_Deferred

(

MSIHANDLE

hInstall

)

CA_API UINT __stdcall Win32_RegistryCopy_Immediate

(

MSIHANDLE

hInstall

)

Copy registry keys. This is a table-driven custom action. Use in combination with AppSecInc::Wix::Extensions::SystemToolsExtension.