Copyright (C) 2000-2012 |
Manpages Tcl_WrongNumArgsSection: Tcl Library Procedures (3)Updated: 8.0 Index Return to Main Contents NAMETcl_WrongNumArgs - generate standard error message for wrong number of argumentsSYNOPSIS#include <tcl.h> Tcl_WrongNumArgs(interp, objc, objv, message) ARGUMENTS
DESCRIPTIONTcl_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:
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 origionally passed in. Using the above example, lets assume that bar is actually an abbreviation for barfly and the object is now an indexObject becasue it was passed to Tcl_GetIndexFromObj. In this case the error message would be:
SEE ALSOTcl_GetIndexFromObjKEYWORDScommand, error message, wrong number of arguments
IndexThis document was created by man2html, using the manual pages. Time: 15:16:28 GMT, March 29, 2024 |