SetBitmapDimensionEx function (wingdi.h)

Article
02/22/2024

The SetBitmapDimensionEx function assigns preferred dimensions to a bitmap. These dimensions can be used by applications; however, they are not used by the system.

Syntax

BOOL SetBitmapDimensionEx(
  [in]  HBITMAP hbm,
  [in]  int     w,
  [in]  int     h,
  [out] LPSIZE  lpsz
);

Parameters

[in] hbm

A handle to the bitmap. The bitmap cannot be a DIB-section bitmap.

[in] w

The width, in 0.1-millimeter units, of the bitmap.

[in] h

The height, in 0.1-millimeter units, of the bitmap.

[out] lpsz

A pointer to a SIZE structure to receive the previous dimensions of the bitmap. This pointer can be NULL.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

Remarks

An application can retrieve the dimensions assigned to a bitmap with the SetBitmapDimensionEx function by calling the GetBitmapDimensionEx function.

The bitmap identified by hBitmap cannot be a DIB section, which is a bitmap created by the CreateDIBSection function. If the bitmap is a DIB section, the SetBitmapDimensionEx function fails.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	wingdi.h (include Windows.h)
Library	Gdi32.lib
DLL	Gdi32.dll