source: trunk/SRC/Utilities/undefine.pro @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 1.3 KB
Line 
1;------------------------------------------------------------
2;------------------------------------------------------------
3;------------------------------------------------------------
4;+
5;
6; @file_comments
7; erase a variable
8; same thing that delvar but usable in a program and usable
9; for one variable simultaneously
10;
11; @categories
12; Utilities 
13;
14; @param VARNAME {in}{required}
15; The name of the variable we want erase
16;
17; @examples
18; IDL> a=1
19; IDL> undefine,a
20; % Compiled module: UNDEFINE.
21; IDL> help, a
22; A               UNDEFINED = <Undefined>
23;
24; @history trouve sur la page web de D.Fanning
25; http://www.dfanning.com :
26;QUESTION: How do I make an IDL variable have a type "undefined"?
27;ANSWER: At the main IDL level you can use the IDL procedure DELVAR to
28;delete an IDL variable and make it undefined. Inside of procedures
29;and functions, I use this little program named UNDEFINE that I got
30;from Andrew Cool at the DSTO High Frequency Radar Division in
31;Adelaide, Australia.
32;
33; @version $Id$
34;
35;-
36;------------------------------------------------------------
37;------------------------------------------------------------
38;------------------------------------------------------------
39   PRO undefine, varname 
40;
41  compile_opt idl2, strictarrsubs
42;
43   tempvar = SIZE(TEMPORARY(varname))
44   END
45
Note: See TracBrowser for help on using the repository browser.