Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

tcl_wrongnumargs(3) [osx man page]

Tcl_WrongNumArgs(3)					      Tcl Library Procedures					       Tcl_WrongNumArgs(3)

__________________________________________________________________________________________________________________________________________________

NAME

       Tcl_WrongNumArgs - generate standard error message for wrong number of arguments

SYNOPSIS

       #include <tcl.h>

       Tcl_WrongNumArgs(interp, objc, objv, message)

ARGUMENTS

       Tcl_Interp interp (in)		     Interpreter in which error will be reported: error message gets stored in its result object.

       int objc (in)			     Number of leading arguments from objv to include in error message.

       Tcl_Obj *const objv[] (in)	     Arguments to command that had the wrong number of arguments.

       const char *message (in) 	     Additional  error	information  to print after leading arguments from objv.  This typically gives the
					     acceptable syntax of the command.	This argument may be NULL.
_________________________________________________________________

DESCRIPTION

       Tcl_WrongNumArgs is a utility procedure that is invoked by command procedures when they discover that they have received the  wrong  number
       of  arguments.  Tcl_WrongNumArgs generates a standard error message and stores it in the result object of interp.  The message includes the
       objc initial elements of objv plus message.  For example, if objv consists of the values foo and bar, objc is 1, and message  is  "fileName
       count" then interp's result object will be set to the following string:
	      wrong # args: should be "foo fileName count"
       If objc is 2, the result will be set to the following string:
	      wrong # args: should be "foo bar fileName count"
       Objc is usually 1, but may be 2 or more for commands like string and the Tk widget commands, which use the first argument as a subcommand.

       Some  of the objects in the objv array may be abbreviations for a subcommand.  The command Tcl_GetIndexFromObj will convert the abbreviated
       string object into an indexObject.  If an error occurs in the parsing of the subcommand we would like  to  use  the  full  subcommand  name
       rather  than  the  abbreviation.   If the Tcl_WrongNumArgs command finds any indexObjects in the objv array it will use the full subcommand
       name in the error message instead of the abbreviated name that was originally passed in.  Using the above example, let us assume  that  bar
       is actually an abbreviation for barfly and the object is now an indexObject because it was passed to Tcl_GetIndexFromObj.  In this case the
       error message would be:
	      wrong # args: should be "foo barfly fileName count"

SEE ALSO

       Tcl_GetIndexFromObj

KEYWORDS

       command, error message, wrong number of arguments

Tcl									8.0						       Tcl_WrongNumArgs(3)

Check Out this Related Man Page

Tk_GetScrollInfo(3)					       Tk Library Procedures					       Tk_GetScrollInfo(3)

__________________________________________________________________________________________________________________________________________________

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

       Tcl_Interp *interp (in)		Interpreter to use for error reporting.

       int argc (in)			Number of strings in argv array.

       const char *argv[] (in)		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.

       int objc (in)			Number of Tcl_Obj's in objv array.

       Tcl_Obj *const objv[] (in)	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.

       double *dblPtr (out)		Filled in with fraction from moveto option, if any.

       int *intPtr (out)		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

Tk									8.0						       Tk_GetScrollInfo(3)
Man Page