Microsoft DirectX 8.0 (C++)

IDirectPlay8LobbyClient::EnumLocalPrograms

Enumerates the lobbied applications that are registered on the system.

HRESULT EnumLocalPrograms(
GUID *const pGuidApplication,
BYTE *const pEnumData,
DWORD *const pdwEnumData,
DWORD *const pdwItems.
const DWORD dwFlags
);

Parameters

pGuidApplication
Pointer to a variable of type GUID that specifies the lobbied application to enumerate. This parameter is optional, and passing NULL enumerates all available lobbied applications.
pEnumData
Pointer to a variable of type BYTE, which is filled with a description of the lobbied application.
pdwEnumData
Pointer to variable of type DWORD that specifies the number of bytes contained in the pEnumData buffer. If the buffer in pEnumData is too small, this method returns DPNERR_BUFFERTOOSMALL and sets this parameter to the size of the required buffer.
pdwItems
Pointer to a variable of type DWORD that contains the number of DPL_APPLICATION_INFO structures in the pEnumData buffer. This parameter is filled only if the method succeeds.
dwFlags
Reserved. Must be 0.

Return Values

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

DPNERR_BUFFERTOOSMALL
DPNERR_INVALIDFLAGS
DPNERR_INVALIDPARAM

Remarks

This method is generally called twice—once to obtain the size of the required buffer, and then with the correct buffer size.

Requirements

  Windows NT/2000: Available as a redistributable for Windows 2000 and later.
  Windows 95/98: Available as a redistributable for Windows 95 and later.
  Header: Declared in Dplobby8.h.