GdiplusStartup

 

 

The GdiplusStartup function initializes Microsoft Windows GDI+. Call GdiplusStartup before making any other GDI+ calls, and call GdiplusShutdown when you have finished using GDI+.

 

 

Syntax

Status GdiplusStartup(      
    ULONG_PTR token *token,

    const GdiplusStartupInput *input,

    GdiplusStartupOutput *output

);

PowerBASIC Syntax

DECLARE FUNCTION GdiplusStartup ( _

    BYREF token AS DWORD _

    BYREF pinput AS GdiplusStartupInput _

    BYREF poutput AS GdiplusStartupOutput _

) AS LONG

Parameters

 

token

[out] Pointer to a DWORD that receives a token. Pass the token to GdiplusShutdown when you have finished using GDI+.

 input

[in] Pointer to a GdiplusStartupInput structure that contains the GDI+ version, a pointer to a debug callback function, a Boolean value that specifies whether to suppress the background thread, and a Boolean value that specifies whether to suppress external image codecs.

 output

[out] Pointer to a GdiplusStartupOutput structure that receives a pointer to a notification hook function and a pointer to a notification unhook function. If the SuppressBackgroundThread data member of the input parameter is FALSE, then this parameter can be NULL.

Return Value 

If the function succeeds, it returns Ok, which is an element of the Status enumeration.

 

If the function fails, it returns one of the other elements of the Status enumeration.

 Remarks 

You must call GdiplusStartup before you create any GDI+ objects, and you must delete all of your GDI+ objects before you call GdiplusShutdown.

 

You can call GdiplusStartup on one thread and call GdiplusShutdown on another thread as long as you delete all of your GDI+ objects (or have them go out of scope) before you call GdiplusShutdown.

 

Do not call GdiplusStartup or GdiplusShutdown in DllMain or in any function that is called by DllMain. If you want to create a dynamic-link library (DLL) that uses GDI+, you should use one of the following techniques to initialize GDI+: 

  • Require your clients to call GdiplusStartup before they call the functions in your DLL and to call GdiplusShutdown when they have finished using your DLL.

  • Export your own startup function that calls GdiplusStartup and your own shutdown function that calls GdiplusShutdown. Require your clients to call your startup function before they call other functions in your DLL and to call your shutdown function when they have finished using your DLL.

  • Call GdiplusStartup and GdiplusShutdown in each of your functions that make GDI+ calls.

 

Valid HTML 4.01 Transitional