GetImage Method, SftPictureObject Object


	SftPictureObject.GetImage Method	Softel vdm, Inc.

Retrieves the picture object attributes defined as a GDI+ image.

Syntax

		VB.NET	object.GetImage(ByRef GDIPlusImage As Integer, ByRef Owned As Boolean)
		VB	object.GetImage(GDIPlusImage As LONG_PTR, Owned As Boolean)
		C#.NET	void object.GetImage(out int GDIPlusImage, out bool Owned);
		VC++	HRESULT object->GetImage(LONG_PTR* GDIPlusImage, VARIANT_BOOL* Owned);
		C	HRESULT object->raw_GetImage(LONG_PTR* GDIPlusImage, VARIANT_BOOL* Owned);
		Delphi	procedure object.GetImage(out GDIPlusImage : Pointer, out Owned : WordBool);

object

A SftPictureObject object.

GDIPlusImage

Returns a pointer to a Gdiplus::Image object.

Owned

Returns True if the GDI+ image is owned by the tree control, False otherwise.

Comments

The GetImage method retrieves the picture object attributes defined as a GDI+ image.

SetImage can be used to assign ownership of a GDI+ image to the tree control, so it automatically deletes the object when it is no longer needed. This is typically only used by C++ applications that have direct access to GDI+ classes.

If the current picture object is not based on an GDI+ image (SftPictureObject.Type other than sftTypeGDIPlus), the returned values are not valid.