IMILBitmapEffectConnectorInfo::GetOptimalFormat method (mileffects.h)

Retrieves the optimal pixel format for the pin.

Syntax

HRESULT GetOptimalFormat(
  [out, retval] WICPixelFormatGUID *pFormat
);

Parameters

[out, retval] pFormat

Type: WICPixelFormatGUID*

When this method returns, contains the optimal pixel format for the pin.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header mileffects.h
Redistributable Microsoft .Net 3.0