Platform SDK: DirectX

IDirectDrawVideoPort::GetOutputFormats

The IDirectDrawVideoPort::GetOutputFormats method retrieves a list of output formats that the DirectDrawVideoPort object supports for a specified input format.

HRESULT GetOutputFormats( 
  LPDDPIXELFORMAT lpInputFormat,  
  LPDWORD lpNumFormats,       
  LPDDPIXELFORMAT lpFormats,  
  DWORD dwFlags               
);

Parameters

lpInputFormat

Address of a DDPIXELFORMAT structure that describes the input format for which conversion information is requested.

lpNumFormats

Address of a variable that contains the number of entries that the array at lpFromats can hold. If this number is less than the total number of codes, the method fills the array with all the codes that 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 to be filled in with the output formats supported by this DirectDrawVideoPort object. If 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 are enumerated. 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 it fails, the method can return one of the following error values:

DDERR_INVALIDOBJECT

DDERR_INVALIDPARAMS

DDERR_MOREDATA

Requirements

  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.