IWICPixelFormatInfo::GetChannelMask method (wincodec.h)

Gets the pixel format's channel mask.

Syntax

HRESULT GetChannelMask(
  [in]      UINT uiChannelIndex,
  [in]      UINT cbMaskBuffer,
  [in, out] BYTE *pbMaskBuffer,
  [out]     UINT *pcbActual
);

Parameters

[in] uiChannelIndex

Type: UINT

The index to the channel mask to retrieve.

[in] cbMaskBuffer

Type: UINT

The size of the pbMaskBuffer buffer.

[in, out] pbMaskBuffer

Type: BYTE*

Pointer to the mask buffer.

[out] pcbActual

Type: UINT*

The actual buffer size needed to obtain the channel mask.

Return value

Type: HRESULT

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

Remarks

If 0 and NULL are passed in for cbMaskBuffer and pbMaskBuffer, respectively, the required buffer size will be returned through pcbActual.

Requirements