Copyright © 2006-2019 MultiMedia Soft

GetOutputDeviceDesc method

Previous pageReturn to chapter overviewNext page

Remarks

 

Retrieves the friendly description of the requested output device (sound card). This method is very useful when you have to fill a combo box with the friendly names of the available output devices.

 

The total number of available output devices can be obtained using the GetOutputDevicesCount method.

 

IMPORTANT NOTE ABOUT THE WINDOWS VERSION: This method is only intended for usage when the operating system is Windows XP or older versions; for Windows Vista and higher versions it's recommended using methods exposed by the CoreAudioDevicesMan class.

 

 

Syntax

 

[Visual Basic]

Public Function GetOutputDeviceDesc (

nOutputIndex as Int16

) as String


 

[C#]

public string GetOutputDeviceDesc (

Int16 nOutputIndex

);


 

[C++]

public: string GetOutputDeviceDesc (

Int16 nOutputIndex

);


 

 

Parameter

Description

 

 

nOutputIndex

Number representing the zero-based index of the output device whose friendly name must be retrieved

 

 

Return value

 

Value

Meaning

 

 

Empty string

The value of the nOutputIndex parameter was out of range. Use the value returned by the GetOutputDevicesCount method in order to know how many output devices are currently installed on the system.

Valid string

The string containing the friendly description of the requested output device.