IDirectDrawVideoPort::GetInputFormats

The IDirectDrawVideoPort::GetInputFormats method 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 lpFormats can 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 lpNumFormats to indicate the total number of codes, and returns DDERR_MOREDATA.

lpFormats

Address of an array of DDPIXELFORMAT structures that will be filled in with the input formats supported by this DirectDrawVideoPort object. If this parameter is NULL, the method sets lpNumFormats to 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 lpFormats parameter to NULL. When the method returns, the variable at lpNumFormats contains the total number of supported input formats.

QuickInfo

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dvp.h.
  Import Library: Use ddraw.lib.