Edit

Share via

GdiplusStartupInputEx::GdiplusStartupInputEx(Version,INT,DebugEventProc,BOOL,BOOL) function (gdiplusinit.h)

  • Article

Important

Some information relates to a prerelease product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Constructor for the GdiplusStartupInputEx structure.

All of the constructor parameters are optional, so you can declare a variable of type GdiplusStartupInputEx without passing any arguments to the constructor, and all of the members will be initialized with appropriate default values.

Syntax

void GdiplusStartupInputEx(
  Version        gdiplusVersion,
  INT            startupParameters,
  DebugEventProc debugEventCallback,
  BOOL           suppressBackgroundThread,
  BOOL           suppressExternalCodecs
);

Parameters

gdiplusVersion

Type: Version

The version of GDI+ to initialize. See the definition of the Version enum below.

enum class Version : UINT32
{
  V2 = 2,
  V3 = 3 // Enables Heif and Avif image codecs.
         // Unlike other functionalities in Gdiplus,
         // these two codecs require COM to be initialized.
};

startupParameters

Type: INT

See GdiplusStartupParams. The default value is GdiplusStartupDefault (0).

debugEventCallback

Type: DebugEventProc

Pointer to your DebugEventProc callback function, which GDI+ can call on debug builds for assertions and warnings. The default value is NULL.

suppressBackgroundThread

Type: BOOL

Boolean value that specifies whether to suppress the GDI+ background thread. If you pass TRUE, then GdiplusStartup returns (in its output parameter) a pointer to a hook function, and a pointer to an unhook function. You must call those functions appropriately to replace the background thread. If you don't want to be responsible for calling the hook and unhook functions, then set this member to FALSE. The default value is FALSE.

suppressExternalCodecs

Type: BOOL

Boolean value that specifies whether you want GDI+ to suppress external image codecs. The default value is FALSE.

Return value

None

Requirements

Requirement Value
Header gdiplusinit.h