DSEnumCallback

The DSEnumCallback function is an application-defined callback function that enumerates the DirectSound drivers. The system calls this function in response to the application's previous call to the DirectSoundEnumerate or DirectSoundCaptureEnumerate function.

Syntax

BOOL CALLBACK DSEnumCallback(
  LPGUID  lpGuid,    
  LPCSTR  lpcstrDescription,  
  LPCSTR  lpcstrModule,   
  LPVOID  lpContext    
);

Parameters

lpGuid

Address of the GUID that identifies the DirectSound driver being enumerated. This value can be passed to the DirectSoundCreate8 function to create a DirectSound object for that driver.

lpcstrDescription

Address of a null-terminated string that provides a textual description of the DirectSound device.

lpcstrModule

Address of a null-terminated string that specifies the module name of the DirectSound driver corresponding to this device.

lpContext

Address of application-defined data. This is the pointer passed to DirectSoundEnumerate or DirectSoundCaptureEnumerate as the lpContext parameter.

Return Values

Returns TRUE to continue enumerating drivers, or FALSE to stop.

Remarks

The application can save the strings passed in the lpcstrDescription and lpcstrModule parameters by copying them to memory allocated from the heap. The memory used to pass the strings to this callback function is valid only while this callback function is running.

Requirements

  Header: Declared in Dsound.h.

See Also

• DirectSoundEnumerate