GetCursorBitmapHandle

Description

Returns the handle to a Win32 bitmap object containing the cursor image in the selected frame.

Syntax

[C#/C++]
public Long GetCursorBitmapHandle (Long lFrameNumber, Long* Width, Long* Height, Bool* HasAlpha)

[VB.NET]
Public Function GetCursorBitmapHandle (ByVal lFrameNumber As Long, ByRef Width As Long, ByRef Height As Long, ByRef HasAlpha As Boolean) As Integer

Parameters

lFrameNumber (in) : the number of the frame for which the cursor bitmap will be retrieved

Width (out) : the width of the cursor bitmap

Height (out) : the height of the cursor bitmap

HasAlpha (out) : True if the cursor bitmap has an alpha channel
 

Return Values

If the function fails, the return value is zero.

If the function succeeds, the return value is a handle to a Win32 bitmap object.

Remarks

If there is no alpha channel, the return bitmap is double the height of the cursor image and contains two images. The upper half is the colour bitmap of the cursor, and the lower half the mask for the cursor.