detach

Detach the named sub-variable from a list variable.

Syntax

result = detach ( variable ) ;

Arguments

list variable

• A list variable in which the specified sub-variable is detached.

Return Value

list result

• element

  When the detach function is used in an expression or an assignment, then the return value is the sub-variable detached from the variable.

  The STATUS variable is set to $ACKNOWLEDGE

• $ACKNOWLEDGE

  When the detach function is used as an lvalue - as a statement - then the variable detached will create or overwrite the top-level variable of the same name. The return value is boolean 1, which is discarded on the stack.

  The STATUS variable is set to $ACKNOWLEDGE

• %INVALID

  Cannot detach variable

  The STATUS variable is set to %INVALID

Warnings

%INVALID : Cannot detach variable

Exceptions

%ARGUMENT : Invalid arguments. Usage: result = detach ( variable ) ;

%IDENTIFIER : 'variable' argument is not a valid identifier, literal, or reference

Description

None

Examples

To execute the example below, press or modify the example to try different variations.
float a.b.c.d = 99.12 ; describe a ; detach a.b ; describe a ; describe b ; detach b.c.d ; describe d ; describe b ;

Related Links

None