User Tools


Macro MULTIPLE-VALUE-SETQ

Syntax

  • multiple-value-setq vars formresult

Arguments and Values

Description

multiple-value-setq assigns values to vars.

The form is evaluated, and each var is assigned to the corresponding value returned by that form. If there are more vars than values returned, nil is assigned to the extra vars. If there are more values than vars, the extra values are discarded.

If any var is the name of a symbol macro, then it is assigned as if by setf. Specifically,

(multiple-value-setq (symbol1 ... symboln) value-producing-form)

is defined to always behave in the same way as

(values (setf (values symbol1 ... symboln) value-producing-form))

in order that the rules for order of evaluation and side-effects be consistent with those used by setf. See section {\secref\SETFofVALUES}.

Examples

;;; TODO condemn toplevel MULTIPLE-VALUE-SETQ

(multiple-value-setq (quotient remainder) (truncate 3.2 2))

1

quotient

1

remainder

1.2

(multiple-value-setq (a b c) (values 1 2))

1

a

1

b

2

c

NIL

(multiple-value-setq (a b) (values 4 5 6))

4

a

4

b

5

Side Effects

None.

Affected By

None.

Exceptional Situations

None.

See Also

Notes

None.

\issue{SYMBOL-MACROLET-SEMANTICS:SPECIAL-FORM} \issue{MULTIPLE-VALUE-SETQ-ORDER:LIKE-SETF-OF-VALUES}