Platform SDK: DirectX

IDDVideoPortContainer::QueryVideoPortStatus

The IDDVideoPortContainer::QueryVideoPortStatus method retrieves the status of a DirectDrawVideoPort object.

HRESULT QueryVideoPortStatus(
  DWORD dwPortId,                 
  LPDDVIDEOPORTSTATUS lpVPStatus  
);

Parameters

dwPortId
Identifier of the video port for which the status information is to be retrieved.
lpVPStatus
Address of a DDVIDEOPORTSTATUS structure to be filled with information about the status of the specified video port.

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_CURRENTLYNOTAVAIL
DDERR_EXCEPTION
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_UNSUPPORTED

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.