LoadGDIPlusImage Method, SftTree Object


	SftTree.LoadGDIPlusImage Method	Softel vdm, Inc.

Loads a GDI+ image from a file.

Syntax

		VB.NET	pGDIPlusImage = object.LoadGDIPlusImage(ByVal Filename As String, ByVal UseEmbeddedColorManagement As Boolean) As Integer
		VB	pGDIPlusImage = object.LoadGDIPlusImage(ByVal Filename As String, ByVal UseEmbeddedColorManagement As Boolean) As LONG_PTR
		C#.NET	int pGDIPlusImage = object.LoadGDIPlusImage(string Filename, bool UseEmbeddedColorManagement);
		VC++	LONG_PTR pGDIPlusImage = object->LoadGDIPlusImage(_bstr_t Filename, VARIANT_BOOL UseEmbeddedColorManagement);
		C	HRESULT object->raw_LoadGDIPlusImage(BSTR Filename, VARIANT_BOOL UseEmbeddedColorManagement, LONG_PTR* pGDIPlusImage);
		Delphi	pGDIPlusImage := object.LoadGDIPlusImage(Filename : WideString; UseEmbeddedColorManagement : WordBool) : Pointer;

object

A SftTree object.

Filename

Specifies the name of the file containing the image to be loaded.

UseEmbeddedColorManagement

Defines whether the new image object applies color correction according to color management information that is embedded in the image file. Embedded information can include International Color Consortium (ICC) profiles, gamma values, and chromaticity information. True specifies that color correction is enabled, and False specifies that color correction is not enabled.

pGDIPlusImage

Returns a Gdiplus::Image pointer or NULL/Nothing if the function failed.

Comments

The LoadGDIPlusImage method loads a GDI+ image from a file.

A GDI+ image created using LoadGDIPlusImage or LoadGDIPlusImageFromResource must be freed using DeleteGDIPlusImage (or the equivalent "delete Gdiplus::Image*", which is usually accessible to C++ applications only).

This method is mainly intended for applications written using a language that does not have direct access to GDI+ (such as VB6). Other languages usually have direct access to GDI+ (such as C++) or have other mechanisms (NETImageObject for .NET applications).