<!doctype HTML public "-//W3C//DTD HTML 4.0 Frameset//EN">

<html>

<!--(==============================================================)-->
<!--(Document created with RoboEditor. )============================-->
<!--(==============================================================)-->

<head>

<title>Procedures Added to the TCL Translator</title>

<!--(Meta)==========================================================-->

<meta name=generator content="RoboHELP by eHelp Corporation - www.ehelp.com">
<meta name=generator-major-version content=0.1>
<meta name=generator-minor-version content=1>
<meta name=filetype content=kadov>
<meta name=filetype-version content=1>
<meta name=page-count content=0>
<meta name=layout-height content=0>
<meta name=layout-width content=0>
<meta name=date content="08 24, 2001 10:41:31 AM">


<!--(Links)=========================================================-->

<link rel="StyleSheet" href="../../css/main_styles.css">



<!--(Style Sheet)===================================================-->

<style type="text/css">
<!--

body {
	background-image: url("../paper.gif");
	background-repeat: repeat;
	background-attachment: scroll;
}

-->
</style>


</head>

<!--(Body)==========================================================-->


<body class="bodydocs" onLoad="top.pageLoader()" bgcolor="#FFFFFF">


<h1 CLASS=Section>Procedures Added to the TCL Translator</h1>

<p CLASS=Paragraph>The special procedures that have been added by NX 
 to the TCL interpreter for you to use in Event Handler procedures are:</p>

<h1>Abort</h1>

<h5 style="margin-left: 40px;">Procedure Name</h5>

<p CLASS=ListBulletTxt><span style="font-weight: bold;">MOM_abort </span><span 
 style="font-style: italic;"><span style="font-weight: bold;">&lt;message&gt;</span></span></p>

<h5 style="margin-left: 40px;">Description</h5>

<p CLASS=ListBulletTxt>This function causes MOM to write <span style="font-style: italic;">message</span> 
 to the syslog and then terminate by ERROR_raising().</p>

<h5 style="margin-left: 40px;">Input</h5>

<p CLASS=ListBulletTxt>message</p>

<h5 style="margin-left: 40px;">Example</h5>

<p CLASS=ListBulletTxt>MOM_abort &quot;Error occurred. Postprocessing has 
 been aborted.&quot;</p>

<h1><a NAME=address_buffer></a>Add To Address Buffer</h1>

<h4 style="margin-left: 40px;">Procedure Name</h4>

<p CLASS=ListBulletTxt><span style="font-weight: bold;">MOM</span><span 
 style="font-style: italic;"><span style="font-weight: bold;">_</span></span><span 
 style="font-weight: bold;">add_to_address_buffer &lt;</span><span style="font-style: italic;"><span 
 style="font-weight: bold;">address name</span></span><span style="font-weight: bold;">&gt; 
 &lt;start|end&gt; &lt;</span><span style="font-style: italic;"><span style="font-weight: bold;">value</span></span><span 
 style="font-weight: bold;">&gt;+</span></p>

<h5 style="margin-left: 40px;">Description</h5>

<p CLASS=ListBulletTxt>Depending on the start/end attribute specified, 
 this extension will add &quot;value(s)&quot; to either the address start 
 buffer or the address end buffer. Each time that this extension is called, 
 it adds to the specified buffer.</p>

<p CLASS=ListBulletTxt>When the contents of the address is sent to the 
 output buffer, the contents of the address start buffer will preceed it 
 and the contents of the end buffer will go after it.</p>

<p CLASS=ListBulletTxt>The address start buffer and the address end buffer 
 are cleared once the they have been sent to the output buffer.</p>

<h5 style="margin-left: 40px;">Input</h5>

<p CLASS=ListBulletTxt>address name, start/end attribute, value(s)</p>

<h5 style="margin-left: 40px;">Example</h5>

<p CLASS=ListBulletTxt>MOM_add_to_address_buffer X end [append end $list2 
 $list1]</p>

<p CLASS=ListBulletTxt>MOM_add_to_address_buffer X start $prefix</p>

<p CLASS=ListBulletTxt>MOM_add_to_address_buffer X start [MOM_do_template 
 Seq_no CREATE]</p>

<p CLASS=ListBulletTxt>MOM_add_to_address_buffer X start &quot;X&quot;</p>

<h1><a NAME=block_buffer></a>Add To Block Buffer</h1>

<h5 style="margin-left: 40px;">Procedure Name</h5>

<p CLASS=ListBulletTxt><span style="font-weight: bold;">MOM</span><span 
 style="font-style: italic;"><span style="font-weight: bold;">_</span></span><span 
 style="font-weight: bold;">add_to_block_buffer &lt;</span><span style="font-style: italic;"><span 
 style="font-weight: bold;">block name</span></span><span style="font-weight: bold;">&gt; 
 &lt;start|end&gt; &lt;</span><span style="font-style: italic;"><span style="font-weight: bold;">value</span></span><span 
 style="font-weight: bold;">&gt;+</span></p>

<h5 style="margin-left: 40px;">Description</h5>

<p CLASS=ListBulletTxt>Depending on the start/end attribute specified, 
 this extension will add &quot;value(s)&quot; to either the block start 
 buffer or the block end buffer. Each time that this extension is called, 
 it adds to the specified buffer.</p>

<p CLASS=ListBulletTxt>When the block is sent to the output buffer, the 
 contents of the block start buffer will preceed it on the line and the 
 contents of the block end buffer will go after it.</p>

<p CLASS=ListBulletTxt>The block start buffer and the block end buffer 
 are cleared once the they have been written to the output buffer.</p>

<h5 style="margin-left: 40px;">Input</h5>

<p CLASS=ListBulletTxt>block name, start/end attribute, value(s)</p>

<h5 style="margin-left: 40px;">Example</h5>

<p CLASS=ListBulletTxt>MOM_add_to_block_buffer From end [append end $list2 
 $list1]</p>

<p CLASS=ListBulletTxt>MOM_add_to_block_buffer From start $prefix</p>

<p CLASS=ListBulletTxt>MOM_add_to_block_buffer Linear start [MOM_do_template 
 Seq_no CREATE]</p>

<p CLASS=ListBulletTxt>MOM_add_to_block _buffer From start &quot;Remark&quot;</p>

<h1><a NAME=line_buffer></a>Add To Line Buffer</h1>

<h5 style="margin-left: 40px;">Procedure Name</h5>

<p CLASS=ListBulletTxt><span style="font-weight: bold;">MOM</span><span 
 style="font-style: italic;"><span style="font-weight: bold;">_</span></span><span 
 style="font-weight: bold;">add_to_line_buffer &lt;start|end&gt; &lt;</span><span 
 style="font-style: italic;"><span style="font-weight: bold;">value</span></span><span 
 style="font-weight: bold;">&gt;+</span></p>

<h5 style="margin-left: 40px;">Description</h5>

<p CLASS=ListBulletTxt>Depending on the start/end attribute specified, 
 this extension will add &quot;value(s)&quot; to either the line's start 
 buffer or the line's end buffer. Each time that this extension is called, 
 it adds to the specified buffer.</p>

<p CLASS=ListBulletTxt>When the contents of the output buffer is sent to 
 the output file, the contents of the line's start buffer will preceed 
 it on the line and the contents of the end buffer will go on the same 
 line after it.</p>

<p CLASS=ListBulletTxt>The line start buffer, line end buffer, and output 
 buffer are all cleared once the they have been written to the output file.</p>

<h5 style="margin-left: 40px;">Input</h5>

<p CLASS=ListBulletTxt>start/end attribute, value(s)</p>

<h5 style="margin-left: 40px;">Example</h5>

<p CLASS=ListBulletTxt>MOM_add_to_line_buffer start [MOM_do_template Linear 
 CREATE]</p>

<p CLASS=ListBulletTxt>MOM_add_to_line_buffer start [append start $list1 
 $list2]</p>

<p CLASS=ListBulletTxt>MOM_add_to_line_buffer start $prefix</p>

<p CLASS=ListBulletTxt>MOM_add_to_line_buffer start &quot;****&quot;</p>

<h1><a NAME=ask_address></a>Ask Address</h1>

<h5 style="margin-left: 40px;">Procedure Name</h5>

<p CLASS=ListBulletTxt><span style="font-weight: bold;">MOM_ask_address_value 
 </span><span style="font-style: italic;"><span style="font-weight: bold;">&lt;address 
 name&gt;</span></span></p>

<h5 style="margin-left: 40px;">Description</h5>

<p CLASS=ListBulletTxt>Always returns the absolute address value NOT the 
 incremental value.</p>

<h5 style="margin-left: 40px;">Input</h5>

<p CLASS=ListBulletTxt>address name</p>

<h5 style="margin-left: 40px;">Example</h5>

<p CLASS=ListBulletTxt>MOM_ask_address_value X</p>

<h1><a NAME=ask_var></a>Ask Environment Variable</h1>

<h5 style="margin-left: 40px;">Procedure Name</h5>

<p CLASS=ListBulletTxt><span style="font-weight: bold;">MOM_ask_env_var 
 </span><span style="font-style: italic;"><span style="font-weight: bold;">&lt;variable 
 name&gt;</span></span></p>

<h5 style="margin-left: 40px;">Description</h5>

<p CLASS=ListBulletTxt>This extension allows you to determine how environment 
 variable &quot;<span style="font-style: italic;">variable name</span>&quot; 
 is set.</p>

<h5 style="margin-left: 40px;">Input</h5>

<p CLASS=ListBulletTxt>variable name</p>

<h5 style="margin-left: 40px;">Example</h5>

<p CLASS=ListBulletTxt>set path [MOM_ask_env_var UGII_CAM_POST_CONFIG_FILE]</p>

<h1><a NAME=ask_event></a>Ask Event Type</h1>

<h5 style="margin-left: 40px;">Procedure Name</h5>

<p CLASS=ListBulletTxt><span style="font-weight: bold;">MOM_ask_event_type</span></p>

<h5 style="margin-left: 40px;">Description</h5>

<p style="text-align: left; margin-left: 80px;"
	align=left>Returns the name of the current event. This is the last 
 event that the event generator executed.</p>

<h5 style="margin-left: 40px;">Input</h5>

<p style="text-align: left; margin-left: 80px;"
	align=left>None</p>

<h5 style="margin-left: 40px;">Example</h5>

<p style="text-align: left;
			margin-left: 80px;
			margin-bottom: 0;"
	align=left>set event[MOM_ask_event_time] </p>

</body>

</html>
