IDirectPlayVoiceServer::GetCompressionTypes Method

Retrieves available compression types for the system.

Syntax

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

Parameters

pData

[out] Pointer to the buffer that receives an array of DVCOMPRESSIONINFO structures that describe the compression types supported by this object.

pdwDataSize

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

pdwNumElements

[out] Pointer to a DWORD value where the method writes the number of elements returned in the array of DVCOMPRESSIONINFO structures.

dwFlags

[in] Reserved. Must be 0.

Return Value

Returns DV_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 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.