Figure Properties - SERC

nargchk
2nargchk
Purpose Check number of input arguments
Syntax msgstring = nargchk(minargs, maxargs, numargs)
msgstring = nargchk(minargs, maxargs, numargs, 'string')
msgstruct = nargchk(minargs, maxargs, numargs, 'struct')
Description Use nargchk inside an M-file function to check that the desired number of input
arguments is specified in the call to that function.
2-1512
msgstring = nargchk(minargs, maxargs, numargs) returns an error
message string msgstring if the number of inputs specified in the call numargs
is less than minargs or greater than maxargs. If numargs is between minargs
and maxargs (inclusive), nargchk returns an empty matrix.
It is common to use the nargin function to determine the number of input
arguments specified in the call.
msgstring = nargchk(minargs, maxargs, numargs, 'string') is
essentially the same as the command shown above, as nargchk returns a string
by default.
msgstruct = nargchk(minargs, maxargs, numargs, 'struct') returns an
error message structure msgstruct instead of a string. The fields of the return
structure contain the error message string and a message identifier. If numargs
is between minargs and maxargs (inclusive), nargchk returns an empty
structure.
When too few inputs are supplied, the message string and identifier are
message: 'Not enough input arguments.'
identifier: 'MATLAB:nargchk:notEnoughInputs'
When too many inputs are supplied, the message string and identifier are
message: 'Too many input arguments.'
identifier: 'MATLAB:nargchk:tooManyInputs'
Remarks nargchk is often used together with the error function. The error function
accepts either type of return value from nargchk: a message string or message
structure. For example, this command provides the error function with a
message string and identifier regarding which error was caught: