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

Last change on this file since 224 was 224, checked in by pinsard, 17 years ago

improvements/corrections of some *.pro headers
  • 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
25; trouve sur la page web de D.Fanning
26; http://www.dfanning.com :
27;QUESTION: How do I make an IDL variable have a type "undefined"?
28;ANSWER: At the main IDL level you can use the IDL procedure DELVAR to
29;delete an IDL variable and make it undefined. Inside of procedures
30;and functions, I use this little program named UNDEFINE that I got
31;from Andrew Cool at the DSTO High Frequency Radar Division in
32;Adelaide, Australia.
33;
34; @version
35; $Id$
36;
37;-
38;------------------------------------------------------------
39;------------------------------------------------------------
40;------------------------------------------------------------
41   PRO undefine, varname
42;
43  compile_opt idl2, strictarrsubs
44;
45   tempvar = SIZE(TEMPORARY(varname))
46   END
47
Note: See TracBrowser for help on using the repository browser.