CWiauFormatConverter::ConvertToBmp method (wiautil.h)

Article
02/22/2024

The CWiauFormatConverter::ConvertToBmp method converts an image to BMP format.

Syntax

HRESULT ConvertToBmp(
  BYTE           *pSource,
  INT            iSourceSize,
  BYTE           **ppDest,
  INT            *piDestSize,
  BMP_IMAGE_INFO *pBmpImageInfo,
  SKIP_AMOUNT    iSkipAmt
);

Parameters

pSource

Points to the memory location containing the first byte of the source image.

iSourceSize

Specifies the size, in bytes, of the source image.

ppDest

Pointer to a memory location that receives the address of the resulting image.

piDestSize

Pointer to a memory location that receives the size, in bytes, of the resulting image.

pBmpImageInfo

Pointer to a BMP_IMAGE_INFO structure that receives information about the resulting image.

iSkipAmt

Optional

Specifies the amount of the BMP header to skip. The default value of this parameter denotes that none of the BMP header is skipped.

Return value

On success, the function returns S_OK. If the function fails, it returns a standard COM error.

Remarks

The caller of this method can pass a result buffer in ppDest and the size in piDestSize.

Alternatively, the caller can set ppDest to NULL and piDestSize to zero in the call to indicate that this method should allocate the memory.

The caller is responsible for freeing the memory using the delete [] operator.

Requirements

Requirement	Value
Target Platform	Desktop
Header	wiautil.h (include Wiautil.h, Wiamindr.h)