PrlSrvCfg_GetSoundOutputDev Function

Obtains a handle of type PHT_HW_GENERIC_DEVICE containing information about a sound device on the host.

Syntax

PRL_RESULT PrlSrvCfg_GetSoundOutputDev(
    PRL_HANDLE hSrvConfig, 
    PRL_UINT32 nIndex, 
    PRL_HANDLE_PTR phDevice
);

File

PrlApiDisp.h

Parameters

hSrvConfig

A handle of type PHT_SERVER_CONFIG.

nIndex

A numeric index identifying the sound device (beginning with 0). To get the number of sound devices available, use the PrlSrvCfg_GetSoundOutputDevsCount function.

phDevice

[out] A pointer to a variable that receives a pointer of type PHT_HW_GENERIC_DEVICE containing the device information.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_SERVER_CONFIG