IDirectDrawVideoPort::GetInputFormats

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

The IDirectDrawVideoPort::GetInputFormatsmethod retrieves the input formats supported by the DirectDrawVideoPort object.

HRESULT GetInputFormats(
LPDWORD
lpNumFormats
,
LPDDPIXELFORMAT
lpFormats
,
DWORD
dwFlags
);

Parameters

lpNumFormats

Address of a variable containing the number of entries that the array at lpFormatscan hold. If this number is less than the total number of codes, the method fills the array with as many codes as will fit, sets the value at lpNumFormatsto indicate the total number of codes, and returns DDERR_MOREDATA.

lpFormats

Address of an array of DDPIXELFORMATstructures that will be filled in with the input formats supported by this DirectDrawVideoPort object. If this parameter is NULL, the method sets lpNumFormatsto the number of supported formats, and then returns DD_OK.

dwFlags

Flags specifying the part of the video signal for which formats will be enumerated. This parameter can be one of the following values:

DDVPFORMAT_VIDEO	Returns formats for the video data.
DDVPFORMAT_VBI	Returns formats for the VBI data.

Return Values

If the method succeeds, the return value is DD_OK.

If the method fails, the return value may be one of the following error values:

DDERR_INVALIDOBJECT

DDERR_INVALIDPARAMS

DDERR_MOREDATA

Remarks

This method can also be used to return the number of formats supported. To do this, set the lpFormatsparameter to NULL. When the method returns, the variable at lpNumFormatscontains the total number of supported input formats.

Requirements

Runs on	Versions	Declared in	Link to
Windows CE OS	2.12 or later. Version 2.12 requires DXPAK 1.0 or later.	dvp.h	ddraw.lib