DirectXRegisterApplication

The DirectXRegisterApplication function registers an application as one designed to work with DirectPlayLobby.

int WINAPI DirectXRegisterApplication(
  HWND hWnd,                       
  LPDIRECTXREGISTERAPP lpDXRegApp  
);

Parameters

hWnd

Handle of the parent window. If this parameter is set to NULL, the desktop is the parent window.

lpDXRegApp

Address of the DIRECTXREGISTERAPP structure that contains the registry entries that are required for the application to function properly with DirectPlayLobby.

Return Values

If this function succeeds, it returns TRUE.

If it fails, it returns FALSE. Call the GetLastError function to get extended error information.

Remarks

The DirectXRegisterApplication function has to have both dsetup.dll and dsetup32.dll which in not installed on the system, but they are included in the SDK.

Although the DirectXRegisterApplication function inserts the registry entries needed for an application to operate with DirectPlayLobby, the recommend method to install and uninstall a lobby application is to use the IDirectPlayLobby3::RegisterApplication and IDirectPlayLobby3::UnregisterApplication. If these registry entries are added with DirectXRegisterApplication, they should be removed with DirectXUnRegisterApplication when the application is uninstalled.

Many commercial install programs remove registry entries automatically when a program is uninstalled. However, such programs do so only if they added the registry entries themselves. If the DirectPlayLobby registry entries were added by DirectXRegisterApplication, commercial install programs do not delete the registry entries when the application is uninstalled. Therefore, DirectPlayLobby registry entries that are created by DirectXRegisterApplication must be deleted by DirectXUnRegisterApplication.

Registry entries needed for DirectPlayLobby access can be created without using DirectXRegisterApplication. This, however, is not generally recommended. See Registering Lobby-Aware Applications in the Microsoft® DirectPlay® documentation.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in Dsetup.h.
  Import Library: Use Dsetup.lib.

See Also

DirectXUnRegisterApplication