GetHICONFromGdPictureImage Method

In This Topic

Exports a specified GdPicture image to a HICON object, known as Windows handle to icon, as an IntPtr value. Please note that it is your responsibility to release the returned HBitmap object once you have no use for it.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function GetHICONFromGdPictureImage( _
   ByVal ImageID As Integer _
) As IntPtr

public IntPtr GetHICONFromGdPictureImage( 
   int ImageID
)

public function GetHICONFromGdPictureImage( 
    ImageID: Integer
): IntPtr;

public function GetHICONFromGdPictureImage( 
   ImageID : int
) : IntPtr;

public: IntPtr GetHICONFromGdPictureImage( 
   int ImageID
)

public:
IntPtr GetHICONFromGdPictureImage( 
   int ImageID
)

Parameters

ImageID: A unique image identifier of the GdPicture image representing the image to export.

Return Value

A pointer to a newly created HICON object, known as Windows handle to icon, as an IntPtr value, containing the specified GdPictureImage data. The GetStat method can be subsequently used to determine if this method has been successful.

Remarks

It is recommend to use the GetStat method to identify the specific reason for the method's failure, if any.

Be aware that you need to release the resulting HICON object with the ReleaseHICON method after being used.

This method requires the Image Documents component to run.

Reference

GdPictureImaging Class
GdPictureImaging Members
CreateGdPictureImageFromHICON(Int32) Method
SaveAsBMP(Int32,String) Method
GetStat Method
ReleaseHICON Method
ReleaseGdPictureImage Method