Bitmap.GetHicon Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns the handle to an icon.

Namespace:   System.Drawing
Assembly:  System.Drawing (in System.Drawing.dll)

[<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)>]
member GetHicon : unit -> nativeint

Return Value

Type: System.IntPtr

A Windows handle to an icon with the same image as the Bitmap.

Exception Condition
Exception

The operation failed.

Initially, an icon created from the handle will have the same size as the original bitmap.

The following code example is designed for use with Windows Forms, and it requires PaintEventArgse, which is a parameter of the Paint event handler. The code performs the following actions:

  • Creates a Bitmap.

  • Draws that object to the screen.

  • Gets an icon handle for the Bitmap.

  • Sets the Form.Icon attribute of the form to an icon created from the handle.

No code example is currently available or this language may not be supported.

SecurityPermission

for calling into unmanaged code. Related enumeration: UnmanagedCode

.NET Framework
Available since 1.1
Return to top
Show: