IUIX_Inst::GetCursorID Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IUIX_Inst::GetCursorID Method}}
 
{{#customTitle:IUIX_Inst::GetCursorID Method}}
 
{{#parentPage:PXV:IUIX_Inst#Methods|GetCursorID|method}}
 
{{#parentPage:PXV:IUIX_Inst#Methods|GetCursorID|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets the ID by the cursor's name.
  
 
== Syntax ==
 
== Syntax ==
Line 14: Line 13:
 
== Parameters ==
 
== Parameters ==
 
;sCursorName
 
;sCursorName
:[in]  Value of BSTR.
+
:[in]  Value of BSTR containing the cursor name. Possible values are:
 +
hand.up
 +
hand.down
 +
article.onstart
 +
article.next
 +
article.prev
 +
article.tostart
 +
article.toend
 +
zoom.in
 +
zoom.out
 +
zoom.na
 +
drag.move
 +
drag.copy
 +
drag.delete
 +
draw.inside
 +
draw.node
 +
text.inside
 +
cross
 +
cross.minus
 +
cross.plus
 +
knee.h
 +
knee.v
 +
snapshot
 +
loupe
 +
text.select.h
 +
text.select.v
 +
link
 +
link.web
 +
pen
 +
pen_up
 +
mcs.up
 +
mcs.topright
 +
mcs.right
 +
mcs.bottomright
 +
mcs.down
 +
mcs.bottomleft
 +
mcs.left
 +
mcs.topleft
 +
 
 
;nCursorID
 
;nCursorID
:[out, retval]  Pointer to LONG.
+
:[out, retval]  Pointer to LONG containing the cursor ID.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 07:02, 21 October 2016


Gets the ID by the cursor's name.

Syntax

HRESULT GetCursorID([in]           BSTR   sCursorName,
                    [out, retval]  LONG*  nCursorID);

Parameters

sCursorName
[in] Value of BSTR containing the cursor name. Possible values are:

hand.up hand.down article.onstart article.next article.prev article.tostart article.toend zoom.in zoom.out zoom.na drag.move drag.copy drag.delete draw.inside draw.node text.inside cross cross.minus cross.plus knee.h knee.v snapshot loupe text.select.h text.select.v link link.web pen pen_up mcs.up mcs.topright mcs.right mcs.bottomright mcs.down mcs.bottomleft mcs.left mcs.topleft

nCursorID
[out, retval] Pointer to LONG containing the cursor ID.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IUIX_Inst