Loads a GDI+ image from an application's or DLL's resources.

C

LPVOID SftTree_LoadGDIPlusImageFromResource(HMODULE hInst,
        LPCTSTR lpszResourceType, LPCTSTR lpszResourceName);

Parameters

hInst

The instance handle of the application or DLL containing the resource.

lpszResourceType

The resource type. Can be a string or an identifier using the MAKEINTRESOURCE macro.

lpszResourceName

The resource name. Can be a string or an identifier using the MAKEINTRESOURCE macro.

Returns

If successful, the return value is a Gdiplus::Image pointer or NULL if the function failed.

Comments

Loads a GDI+ image from an application's or DLL's resources.

This function is mainly intended for applications written using C. Because Gdiplus is C++ based, C applications don't readily have access to the Gdiplus::Image class and cannot use Bitmap::FromResource to load a GDI+ image. Using SftTree_LoadGDIPlusImageFromResource even C applications can use GDI+ images, without needing access to GDI+ itself.

The application retains ownership of the Gdiplus::Image pointer returned by SftTree_LoadGDIPlusImageFromResource. Once the image is no longer needed, it can be released using SftTree_FreeGDIPlusImageLoadedFromResource, which frees the associated memory.

LoadGDIPlusImageFromResource provides essentially the same service as the GDI+ Bitmap::FromResource function.

Please note that GDI+ images cannot be defined as BITMAP resources. They must be included as custom resources. The Pictures sample demonstrates how this is accomplished.

See Also  C/C++ API  |  Categories |  Notifications