IUIX_Inst::GetCursorID Method

From Tracker Software PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
(Parameters)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::GetCursorID Method}}
 
{{#customTitle:IUIX_Inst::GetCursorID Method}}
 +
{{#parentPage:PXV:IUIX_Inst#Methods|GetCursorID|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets the ID by the cursor's name.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetCursorID([in] BSTR pCursorName, [out, retval] LONG* pCursorID);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetCursorID([in]           BSTR   sCursorName,
 +
                    [out, retval] LONG* nCursorID);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pCursorName''
+
;sCursorName
:[in]  Value of BSTR.
+
:[in]  Value of BSTR containing the cursor name. Possible values are:
;''pCursorID''
+
:{| class="wikitable properties"
:[out, retval]  Pointer to LONG.
+
|-
 +
|
 +
* 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
 +
;&nbsp;
 +
;&nbsp;
 +
;&nbsp;
 +
|-
 +
|}
 +
;nCursorID
 +
:[out, retval]  Pointer to LONG containing the cursor ID.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 69:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_Inst|IUIX_Inst]].
+
[[PXV:IUIX_Inst|IUIX_Inst]]

Latest revision as of 08: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.

See Also

IUIX_Inst