<html> <head> <title>TCCEnv_Functions - TCCUsefulFunctions</title> <link rel="stylesheet" type="text/css" href="../styles/main.css"> <script language=JavaScript src="../javascript/main.js"></script></head> <body class="FramedContentPage" onLoad="NDOnLoad()"> <script language=JavaScript> <!-- if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script> <!-- Generated by Natural Docs, version 1.4 --> <!-- http://www.naturaldocs.org --> <!-- saved from url=(0026)http://www.naturaldocs.org --> <div id=Content> <div class="CFile"> <div class=CTopic id=MainTopic> <h1 class=CTitle> <a name="TCCEnv_Functions"></a>TCCEnv_Functions</h1> <div class=CBody> <h4 class=CHeading>Purpose</h4> <p>This module supports handling of environment e.g. environment variable operations</p> <h4 class=CHeading>Module Parameters</h4> <p>-</p> <h4 class=CHeading>Module depends on</h4> <p>-</p> <!--START_ND_SUMMARY--> <div class=Summary> <div class=STitle>Summary</div> <div class=SBorder> <table border=0 cellspacing=0 cellpadding=0 class=STable> <tr class="SMain"> <td class=SEntry> <a href="#TCCEnv_Functions" >TCCEnv_Functions</a></td> <td class=SDescription>This module supports handling of environment e.g. </td></tr> <tr class="SGroup"> <td class=SEntry> <a href="#Functions" >Functions</a></td> <td class=SDescription></td></tr> <tr class="SFunction SIndent1 SMarked"> <td class=SEntry> <a href="#f_GetEnv" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">f_GetEnv</a></td> <td class=SDescription>Return the environment variable specified via p_env_name</td></tr> <tr class="SFunction SIndent1"> <td class=SEntry> <a href="#f_PutEnv" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">f_PutEnv</a></td> <td class=SDescription>Set the environment variable p_env_name to p_env_value.</td></tr></table></div></div> <!--END_ND_SUMMARY--></div></div></div> <div class="CGroup"> <div class=CTopic> <h3 class=CTitle> <a name="Functions"></a>Functions</h3></div></div> <div class="CFunction"> <div class=CTopic> <h3 class=CTitle> <a name="f_GetEnv"></a>f_GetEnv</h3> <div class=CBody> <blockquote> <table border=0 cellspacing=0 cellpadding=0 class=Prototype> <tr> <td> <table border=0 cellspacing=0 cellpadding=0> <tr> <td class=PBeforeParameters nowrap>external function f_GetEnv(</td> <td class=PTypePrefix nowrap>in </td> <td class=PType nowrap>charstring </td> <td class=PParameter nowrap>p_env_name</td> <td class=PAfterParameters nowrap>) return charstring</td></tr></table></td></tr></table></blockquote> <h4 class=CHeading>Purpose</h4> <p>Return the environment variable specified via p_env_name</p> <h4 class=CHeading>Parameters</h4> <table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList> <tr> <td class=CDLEntry>p_env_name</td> <td class=CDLDescription> <b>in</b> <b>charstring</b> - name of the environment variable</td></tr></table> <h4 class=CHeading>Return Value</h4> <table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList> <tr> <td class=CDLEntry>charstring</td> <td class=CDLDescription>value of the environment variable</td></tr></table> <h4 class=CHeading>Errors</h4> <p>-</p> <h4 class=CHeading>Detailed description</h4> <p>-</p></div></div></div> <div class="CFunction"> <div class=CTopic> <h3 class=CTitle> <a name="f_PutEnv"></a>f_PutEnv</h3> <div class=CBody> <blockquote> <table border=0 cellspacing=0 cellpadding=0 class=Prototype> <tr> <td> <table border=0 cellspacing=0 cellpadding=0> <tr> <td class=PBeforeParameters nowrap>external function f_PutEnv(</td> <td class=PTypePrefix nowrap>in </td> <td class=PType nowrap>charstring </td> <td class=PParameter nowrap>p_env_name,</td></tr> <tr> <td></td> <td class=PTypePrefix nowrap>in </td> <td class=PType nowrap>charstring </td> <td class=PParameter nowrap>p_env_value</td> <td class=PAfterParameters nowrap>) return boolean</td></tr></table></td></tr></table></blockquote> <h4 class=CHeading>Purpose</h4> <p>Set the environment variable p_env_name to p_env_value.</p> <h4 class=CHeading>Parameters</h4> <table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList> <tr> <td class=CDLEntry>p_env_name</td> <td class=CDLDescription> <b>in</b> <b>charstring</b> - name of the environment variable</td></tr> <tr> <td class=CDLEntry>p_env_value</td> <td class=CDLDescription> <b>in</b> <b>charstring</b> - value of the environment variable</td></tr></table> <h4 class=CHeading>Return Value</h4> <table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList> <tr> <td class=CDLEntry>boolean</td> <td class=CDLDescription>true if set of environment variable was successful, false else</td></tr></table> <h4 class=CHeading>Errors</h4> <p>-</p> <h4 class=CHeading>Detailed description</h4> <p>-</p></div></div></div> </div> <!--Content--> <!--START_ND_TOOLTIPS--> <div class=CToolTip id="tt1"> <div class=CFunction> <blockquote> <table border=0 cellspacing=0 cellpadding=0 class=Prototype> <tr> <td> <table border=0 cellspacing=0 cellpadding=0> <tr> <td class=PBeforeParameters nowrap>external function f_GetEnv(</td> <td class=PTypePrefix nowrap>in </td> <td class=PType nowrap>charstring </td> <td class=PParameter nowrap>p_env_name</td> <td class=PAfterParameters nowrap>) return charstring</td></tr></table></td></tr></table></blockquote>Return the environment variable specified via p_env_name</div></div> <div class=CToolTip id="tt2"> <div class=CFunction> <blockquote> <table border=0 cellspacing=0 cellpadding=0 class=Prototype> <tr> <td> <table border=0 cellspacing=0 cellpadding=0> <tr> <td class=PBeforeParameters nowrap>external function f_PutEnv(</td> <td class=PTypePrefix nowrap>in </td> <td class=PType nowrap>charstring </td> <td class=PParameter nowrap>p_env_name,</td></tr> <tr> <td></td> <td class=PTypePrefix nowrap>in </td> <td class=PType nowrap>charstring </td> <td class=PParameter nowrap>p_env_value</td> <td class=PAfterParameters nowrap>) return boolean</td></tr></table></td></tr></table></blockquote>Set the environment variable p_env_name to p_env_value.</div></div> <!--END_ND_TOOLTIPS--> <script language=JavaScript> <!-- if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>