---
name: "GetScroll"
section: "3"
platform: "macos"
package: "tcl"
version: "152"
release: "macOS 26.5"
platforms: ["macos"]
url: "https://new.carta.tech/GetScroll/3"
---

# GetScroll(3)

parse arguments for scrolling commands

## NAME

Tk\_GetScrollInfo, Tk\_GetScrollInfoObj - parse arguments for scrolling commands

## SYNOPSIS

```
#include <tk.h>

int
Tk_GetScrollInfo(interp, argc, argv, dblPtr, intPtr)

int
Tk_GetScrollInfoObj(interp, objc, objv, dblPtr, intPtr)
```

## ARGUMENTS

Interpreter to use for error reporting. Number of strings in *argv* array. Argument strings.  These represent the entire widget command, of which the first word is typically the widget name and the second word is typically **xview** or **yview**. Number of Tcl\_Obj's in *objv* array. Argument objects.  These represent the entire widget command, of which the first word is typically the widget name and the second word is typically **xview** or **yview**. Filled in with fraction from **moveto** option, if any. Filled in with line or page count from **scroll** option, if any. The value may be negative.

## DESCRIPTION

**Tk\_GetScrollInfo** parses the arguments expected by widget scrolling commands such as **xview** and **yview**. It receives the entire list of words that make up a widget command and parses the words starting with *argv*\[2\]. The words starting with *argv*\[2\] must have one of the following forms: **moveto** *fraction* **scroll** *number* **units** **scroll** *number* **pages**

Any of the **moveto**, **scroll**, **units**, and **pages** keywords may be abbreviated. If *argv* has the **moveto** form, **TK\_SCROLL\_MOVETO** is returned as result and *\*dblPtr* is filled in with the *fraction* argument to the command, which must be a proper real value. If *argv* has the **scroll** form, **TK\_SCROLL\_UNITS** or **TK\_SCROLL\_PAGES** is returned and *\*intPtr* is filled in with the *number* value, which must be a proper integer. If an error occurs in parsing the arguments, **TK\_SCROLL\_ERROR** is returned and an error message is left in *interp-\>result*.

**Tk\_GetScrollInfoObj** is identical in function to **Tk\_GetScrollInfo**.  However, **Tk\_GetScrollInfoObj** accepts Tcl\_Obj style arguments, making it more appropriate for use with new development.

## KEYWORDS

parse, scrollbar, scrolling command, xview, yview