Skip to content

Commit

Permalink
Add return value section for CaretGetPos
Browse files Browse the repository at this point in the history
  • Loading branch information
Ragnar-F committed Jul 15, 2020
1 parent 5129e50 commit e875aa9
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/commands/CaretGetPos.htm
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h1>CaretGetPos</h1>

<p>Retrieves the current position of the caret (text insertion point).</p>

<pre class="Syntax"><span class="func">CaretGetPos</span>(<span class="optional">OutputVarX, OutputVarY</span>)</pre>
<pre class="Syntax">CaretFound := <span class="func">CaretGetPos</span>(<span class="optional">OutputVarX, OutputVarY</span>)</pre>
<h2>Parameters</h2>
<dl>
<dt>OutputVarX/Y</dt>
Expand All @@ -25,8 +25,11 @@ <h2>Parameters</h2>
</dd>
</dl>

<h2>Return Value</h2>
<p>Type: <a href="../Concepts.htm#boolean">Integer (boolean)</a></p>
<p>If there is no active window or the caret position cannot be determined, the function returns 0 (false) and the output variables are made blank. The function returns 1 (true) if the system returned a caret position, but this does not necessarily mean a caret is visible.</p>

<h2>Remarks</h2>
<p>If there is no active window or the caret position cannot be determined, the function returns false and the output variables are made blank. The function returns true if the system returned a caret position, but this does not necessarily mean a caret is visible.</p>
<p>Any of the output variables may be omitted if the corresponding information is not needed.</p>
<p>Note that some windows (e.g. certain versions of MS Word) report the same caret position regardless of its actual position.</p>

Expand Down

0 comments on commit e875aa9

Please sign in to comment.