built-in method

uninstantiation_error/1

Description

uninstantiation_error(Culprit)

Throws an uninstantiation error. Used when an argument or one of its sub-arguments is bound but a variable is required. For example, trying to open a file with a stream argument bound.

This built-in method is declared private and thus cannot be used as a message to an object. Calling this predicate is equivalent to the following sequence of calls:

...,
context(Context),
throw(error(uninstantiation_error(Culprit), Context)).

This allows the user to generate errors in the same format used by the runtime.

Modes and number of proofs

uninstantiation_error(@nonvar) - error

Errors

When called:

uninstantiation_error(Culprit)

Examples

...,
var(Handler),
uninstantiation_error(my_stream).

See also

catch/3, throw/1, context/1, instantiation_error/0, type_error/2, domain_error/2, consistency_error/3, existence_error/2, permission_error/3, representation_error/1, evaluation_error/1, resource_error/1, syntax_error/1, system_error/0