InkOverlay.MouseIcon property

Gets or sets the custom mouse icon.

This property is read/write.

Syntax


HRESULT put_MouseIcon(
  [in]          IPictureDisp *MouseIcon
);

HRESULT get_MouseIcon(
  [out, retval] IPictureDisp **MouseIcon
);

Property value

The custom mouse icon. The default value is NULL.

Error codes

NameMeaning
S_OK

Success.

E_POINTER

The parameter is an invalid pointer.

E_UNEXPECTED

Unexpected parameter or property type.

E_INK_EXCEPTION

An exception occurred while processing.

E_INVALIDARG

The recognition range is invalid.

Remarks

The [propputref] function can accept a NULL reference, in which case S_OK is returned.

This property provides a custom icon that is used when the MousePointer property is set to IMP_Custom.

You can use the MouseIcon property to load either cursor or icon files. The MouseIcon property provides your application with access to custom cursors of any size with any desired hot spot location.

Requirements

Minimum supported client

Windows XP Tablet PC Edition [desktop apps only]

Minimum supported server

None supported

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

InkOverlay Class
MousePointer Property

 

 

Show: