Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.5.11.19
Gets the encoder sub-format flags for a particular sub-format and pixel format.
Syntax
HRESULT GetSubFormatFlags(
WICPixelFormatGUID guidPixelFormat,
UINT uSubFormatIndex,
WICLeadSubFormatFlags *puFlags
);
|
|
Parameters
|
|
Return ValuesReturns S_OK if successful, or an error value otherwise.
RemarksThis method returns the WICLeadSubFormatFlags for a particular sub-format of a LEAD encoder.
You must first call GetSubFormats to get the array of valid sub-formats for the particular LEAD encoder. Then call GetSubFormatFlags on a particular member of the sub-format array to get the flags for the sub-format. The sub-format flags will be a logical "or" of zero or more of the WICLeadSubFormatFlags. Note that the uSubFormatIndex argument is an index into the sub-format array, and NOT a WICLeadSubFormat constant.
The (sub-format)/(sub-format flag) pair is unique, and has a name that is obtained by calling the GetSubFormatFriendlyName method. For more information, see GetSubFormats.
ExampleFor an example, refer to the IWICLeadBitmapEncoder::GetSubFormats method.
See Also