-
Notifications
You must be signed in to change notification settings - Fork 0
/
mcf__string2file_8sas_source.html
256 lines (254 loc) · 19.3 KB
/
mcf__string2file_8sas_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- HTML header for doxygen 1.8.17-->
<html xmlns="https://www.w3.org/1999/xhtml" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=9" />
<meta property="og:type" content="website">
<meta property="og:title" content="MacroCore" />
<meta property="og:url" content="https://core.sasjs.io" />
<meta property="og:image" content="https://core.sasjs.io/Macro_core_website_1.png" />
<meta name="author" content="Allan Bowe">
<meta name="generator" content="Doxygen 1.12.0" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="description" content="Macros for SAS Application Developers" />
<meta name="og:description" content="Macros for SAS Application Developers" />
<title>fcmp/mcf_string2file.sas Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon" />
<link href="new_stylesheet.css" rel="stylesheet" type="text/css"/>
<!-- Matomo -->
<script>
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function () {
var u = "https://analytics.4gl.io/";
_paq.push(['setTrackerUrl', u + 'matomo.php']);
_paq.push(['setSiteId', '6']);
var d = document, g = d.createElement('script'), s = d.getElementsByTagName('script')[0];
g.async = true; g.src = u + 'matomo.js'; s.parentNode.insertBefore(g, s);
})();
</script>
<!-- End Matomo Code -->
</head>
<body>
<div id="top">
<!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px">
<td id="projectlogo">
<a href=""><img alt="Logo" src="Macro_core_website_1.png" /></a>
</td>
<td id="projectalign" style="padding-left: 0.5em">
<div id="projectbrief">
Macros for SAS Application Developers<br />
<a href="https://github.com/sasjs/core">
https://github.com/sasjs/core
</a>
</div>
</td>
</tr>
</table>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
</div>
</body>
</html>
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('mcf__string2file_8sas_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">mcf_string2file.sas</div></div>
</div><!--header-->
<div class="contents">
<a href="mcf__string2file_8sas.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> @file</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> @brief Adds a string to a file</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> @details Creates an fcmp function for appending a string to an external file.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> If the file does not exist, it is created.</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"></span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> The function itself takes the following (positional) parameters:</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"></span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> | PARAMETER | DESCRIPTION |</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> |------------|-------------|</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> | filepath $ | full path to the file|</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> | string $ | string to add to the file |</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> | mode $ | mode of the output - either APPEND (default) or CREATE |</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"></span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> It returns 0 if successful, or -1 if an error occured.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"></span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> Usage:</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"></span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> %mcf_string2file(wrap=YES, insert_cmplib=YES)</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"></span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> data _null_;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> rc=mcf_string2file(</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> "%sysfunc(pathname(work))/newfile.txt"</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> , "This is a test"</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> , "CREATE");</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> run;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment"></span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment"> data _null_;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"> infile "%sysfunc(pathname(work))/newfile.txt";</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"> input;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> putlog _infile_;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> run;</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"></span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> @param [out] wrap= (NO) Choose YES to add the proc fcmp wrapper.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment"> @param [out] lib= (work) The output library in which to create the catalog.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment"> @param [out] cat= (sasjs) The output catalog in which to create the package.</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment"> @param [out] pkg= (utils) The output package in which to create the function.</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"> Uses a 3 part format: libref.catalog.package</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> @param [out] insert_cmplib= DEPRECATED - The CMPLIB option is checked and</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment"> values inserted only if needed.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"></span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"> <h4> SAS Macros </h4></span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"> @li mcf_init.sas</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment"></span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"> <h4> Related Programs </h4></span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"> @li mcf_stpsrv_header.test.sas</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> @li mp_init.sas</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"></span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment">**/</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>%macro mcf_string2file(wrap=NO</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> ,insert_cmplib=DEPRECATED</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> ,lib=WORK</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> ,cat=SASJS</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> ,pkg=UTILS</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>)<span class="comment">/*/STORE SOURCE*/</span>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>%local i var cmpval found;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span>%<span class="keywordflow">if</span> %mcf_init(mcf_string2file)=1 %then %<span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>%<span class="keywordflow">if</span> &wrap=YES %then %<span class="keywordflow">do</span>;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> proc fcmp outlib=&lib..&cat..&pkg;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span>%end;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="keyword">function</span> mcf_string2file(filepath $, <span class="keywordtype">string</span> $, mode $);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordflow">if</span> mode=<span class="stringliteral">'APPEND'</span> then fmode=<span class="charliteral">'a'</span>;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keywordflow">else</span> fmode=<span class="charliteral">'o'</span>;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> length fref $8;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> rc=filename(fref,filepath);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordflow">if</span> (rc ne 0) then <span class="keywordflow">return</span>( -1 );</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> fid = fopen(fref,fmode);</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keywordflow">if</span> (fid = 0) then <span class="keywordflow">return</span>( -1 );</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> rc=fput(fid, <span class="keywordtype">string</span>);</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> rc=fwrite(fid);</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> rc=fclose(fid);</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> rc=filename(fref);</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordflow">return</span>(0);</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span>endsub;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span>%<span class="keywordflow">if</span> &wrap=YES %then %<span class="keywordflow">do</span>;</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> quit;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span>%end;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment">/* insert the CMPLIB if not already there */</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span>%let cmpval=%sysfunc(getoption(cmplib));</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span>%let found=0;</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span>%<span class="keywordflow">do</span> i=1 %to %sysfunc(countw(&cmpval,%str( %(%))));</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> %let var=%scan(&cmpval,&i,%str( %(%)));</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> %<span class="keywordflow">if</span> &var=&lib..&cat %then %let found=1;</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span>%end;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>%<span class="keywordflow">if</span> &found=0 %then %<span class="keywordflow">do</span>;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> options insert=(CMPLIB=(&lib..&cat));</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span>%end;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>%mend mcf_string2file;</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.17-->
<!-- start footer part -->
<div id="nav-path" class="navpath">
<!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_7745ead704f7eb9eda9998037fbe6296.html">fcmp</a></li><li class="navelem"><a class="el" href="mcf__string2file_8sas.html">mcf_string2file.sas</a></li>
<li class="footer">
Generated by
<a href="https://www.doxygen.org/index.html">
<img class="footer" src="doxygen.svg" alt="doxygen"
/></a>
1.12.0
</li>
<li>
<i> For more information visit the </i>
<a href="https://github.com/sasjs/core">Macro Core library</a>.
</li>
</ul>
</div>