source: trunk/SRC/Documentation/idldoc_assistant_output/Calendar/date2string.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation

File size: 3.3 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>date2string.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="date2jul.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="daysinmonth.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Calendar/</font></h1>
58    <h2>date2string.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 create a nice and readable format to print a date
65
66
67   
68
69     
70      <a name="#_date2string"></a>
71
72      <h2>date2string  <font size="-1" color="#006633">
73 Calendar, String
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>date2string(<i><a href="#_date2string_keyword_yyyymmdd">yyyymmdd</a></i>, <a href="#_date2string_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 a string containing the date in a easy readable format with the
83 same number of elements than yyyymmdd.
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_date2string_keyword_yyyymmdd"></a>
91    <h4>yyyymmdd&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
95      <font size="-1" color="#006633">required</font>
96     
97      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalor or array</i></font>
98     
99     
100    </h4>
101
102   
103 the date in the format yyyymmdd.
104
105   
106   
107
108   
109    <h3>Keywords</h3>
110
111   
112    <a name="#_date2string_keyword__EXTRA"></a>
113    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
114     
115     
116     
117     
118     
119     
120     
121     
122    </h4>
123
124   
125 Used to pass keywords to <proidl>string</proidl> function
126
127   
128   
129
130    <h3>Examples</h3><pre>
131
132 IDL> print, date2string(19900123)
133    Jan 23, 1990
134 IDL> print, date2string(19900123, format = '(C(CMOA))')
135    JAN 23, 1990
136
137    </pre><h3>Version history</h3>
138   
139    <h4>Version</h4>
140 $Id: date2string.pro 327 2007-12-13 16:22:35Z pinsard $
141
142    <h4>History</h4>
143 Sebastien Masson (smasson@lodyc.jussieu.fr)
144 Creation ???
145 update/review June 2005 Sebastien Masson.
146
147   
148
149   
150   
151   
152   
153   
154
155   
156   
157   
158   
159   
160   
161   
162
163    <font size="-3"><p>&nbsp;</p></font>
164    <hr size="1" color="#CCCCCC"/>
165     
166
167   
168
169    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
170
171  </body>
172</html>
Note: See TracBrowser for help on using the repository browser.