IDirectPlay8LobbiedApplication::RegisterProgram Method

DirectPlay

 
Microsoft DirectX 9.0 SDK Update (Summer 2003)

IDirectPlay8LobbiedApplication::RegisterProgram Method


Registers a lobby-aware application with Microsoft® DirectPlay®. Applications must be registered to enable lobby launching.

Syntax

HRESULT RegisterProgram(      
    PDPL_PROGRAM_DESC pdplProgramDesc,     const DWORD dwFlags );

Parameters

pdplProgramDesc
[in] Pointer to the DPL_PROGRAM_DESC structure that describes the lobby-aware application to register.
dwFlags
[in] Reserved. Must be 0.

Return Value

Returns S_OK if successful, or one of the following error values.

DPNERR_INVALIDFLAGSThe flags passed to this method are invalid.
DPNERR_INVALIDPARAMOne or more of the parameters passed to the method are invalid.

Remarks

The application needs to register only once. It should be unregistered with a call to the IDirectPlay8LobbiedApplication::UnRegisterProgram method when it is uninstalled.

IDirectPlay8LobbiedApplication::RegisterProgram must be used. You cannot manually enter application information in the registry. Failure to use this interface might make your application nonportable and incompatible with later versions of DirectPlay.

If your application is running on Microsoft Windows® Powered Pocket PC 2002, do not set the pwszExecutablePath member of the DPL_PROGRAM_DESC structure to NULL unless your application's executable is located in the Windows directory (\Windows). If it is not in that directory, set pwszExecutablePath to the correct path.



© 2003 Microsoft Corporation. All rights reserved.