IDirectPlayVoiceClient::GetCompressionTypes Method

Retrieves the available compression types on the system.

Syntax

HRESULT GetCompressionTypes(      
    PVOID pData,
    PDWORD pdwDataSize,
    PDWORD pdwNumElements,
    DWORD dwFlags
);

Parameters

pData

[out] Pointer to buffer that receives an array of DVCOMPRESSIONINFO structures, one structure for every compression type supported through this object.

pdwDataSize

[in] Pointer to a DWORD that contains the size of the buffer, in bytes, passed in the pData parameter.

pdwNumElements

[out] Pointer to a DWORD where the method writes the number of elements returned in the array of DVCOMPRESSIONINFO structures. This contains the number of structures only if the buffer specified in the pData is large enough to hold the information.

dwFlags

[in] Reserved. Must be 0.

Return Value

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

DVERR_BUFFERTOOSMALL	The supplied buffer is not large enough to contain the requested data.
DVERR_INVALIDFLAGS	The flags passed to this method are invalid.
DVERR_INVALIDPARAM	One or more of the parameters passed to the method are invalid.
DVERR_INVALIDPOINTER	The pointer specified is invalid.

Remarks

If the buffer passed is not large enough to store the list of compression types, the method returns DVERR_BUFFERTOOSMALL and the pdwDataSize parameter is set to the minimum required size.