IUIX_Inst::GetCursorID Method
From PDF XChange PDF SDK
(→Parameters) |
|||
(2 intermediate revisions by the same user not shown) | |||
Line 14: | Line 14: | ||
;sCursorName | ;sCursorName | ||
:[in] Value of BSTR containing the cursor name. Possible values are: | :[in] Value of BSTR containing the cursor name. Possible values are: | ||
− | hand.up | + | :{| class="wikitable properties" |
− | hand.down | + | |- |
− | article.onstart | + | | |
− | article.next | + | * hand.up |
− | article.prev | + | * hand.down |
− | article.tostart | + | * article.onstart |
− | article.toend | + | * article.next |
− | zoom.in | + | * article.prev |
− | zoom.out | + | * article.tostart |
− | zoom.na | + | * article.toend |
− | drag.move | + | * zoom.in |
− | drag.copy | + | * zoom.out |
− | drag.delete | + | * zoom.na |
− | draw.inside | + | | |
− | draw.node | + | * drag.move |
− | text.inside | + | * drag.copy |
− | cross | + | * drag.delete |
− | cross.minus | + | * draw.inside |
− | cross.plus | + | * draw.node |
− | knee.h | + | * text.inside |
− | knee.v | + | * cross |
− | snapshot | + | * cross.minus |
− | loupe | + | * cross.plus |
− | text.select.h | + | * knee.h |
− | text.select.v | + | | |
− | link | + | * knee.v |
− | link.web | + | * snapshot |
− | pen | + | * loupe |
− | pen_up | + | * text.select.h |
− | mcs.up | + | * text.select.v |
− | mcs.topright | + | * link |
− | mcs.right | + | * link.web |
− | mcs.bottomright | + | * pen |
− | mcs.down | + | * pen_up |
− | mcs.bottomleft | + | * mcs.up |
− | mcs.left | + | | |
− | mcs.topleft | + | * mcs.topright |
− | + | * mcs.right | |
+ | * mcs.bottomright | ||
+ | * mcs.down | ||
+ | * mcs.bottomleft | ||
+ | * mcs.left | ||
+ | * mcs.topleft | ||
+ | ; | ||
+ | ; | ||
+ | ; | ||
+ | |- | ||
+ | |} | ||
;nCursorID | ;nCursorID | ||
:[out, retval] Pointer to LONG containing the cursor ID. | :[out, retval] Pointer to LONG containing the cursor ID. |
Latest revision as of 09:05, 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.