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

<html>

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

<head>

<title>Run User Function</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=1>
<meta name=layout-height content=2621>
<meta name=layout-width content=488>
<meta name=date content="02 1, 2006 9:57:30 AM">


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

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



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

<style>
<!--
body {background-color: #ffffff;}
-->
</style>


</head>

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


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


<h1>Run User Function</h1>

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

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

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

<p CLASS=ListBulletTxt>This function causes MOM to call the function named 
 <span style="font-style: italic;">entry_point_name </span>in the shared 
 library named <span style="font-style: italic;">shared_library_name</span>. 
 That function can then extend the translator from which MOM_run_user_function 
 was called. It will do this by calling a User Function function named 
 UF_MOM_extend_translator( param, &quot;extension_name&quot;, extension_entry_point 
 ). The param will be passed into <span style="font-style: italic;">entry_point_name</span> 
 as the first argument. The signature of <span style="font-style: italic;">entry_point_name</span> 
 is the same as ufusr. The extension_name is the name of the function as 
 it will appear in a TCL script. The extension_entry_point is the actual 
 address of the function to be called by the interpreter when interpreting 
 the extension_name call. (See Tcl_CmdProc.)</p>

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

<p style="text-align: left; margin-left: 80px;"
	align=left>shared_library_name - Full path name of the shared library 
 where entry_point_name resides.</p>

<p style="text-align: left; margin-left: 80px;"
	align=left>entry_point_name - Name of the entry point to execute.</p>

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

<p style="text-align: left; margin-left: 80px;"
	align=left>MOM_run_user_function /usr/local/shlib/lib.sl extendInterp</p>

<h5 style="margin-left: 40px; font-weight: normal;"><a HREF="../uf_mom_extend_examples.htm">For 
 a more thorough example, click here.</a></h5>

<h1><a NAME=set_address></a>Set Address Format</h1>

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

<p CLASS=ListBulletTxt><span style="font-weight: bold;">MOM_set_address_format 
 &lt;</span><span style="font-style: italic;"><span style="font-weight: bold;">Address 
 Name</span></span><span style="font-weight: bold;">&gt; &lt;</span><span 
 style="font-style: italic;"><span style="font-weight: bold;">Format Name</span></span><span 
 style="font-weight: bold;">&gt;</span></p>

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

<p style="text-align: left; margin-left: 80px;"
	align=left>This function redefines the format to be used for the &lt;<span 
 style="font-style: italic;">Address Name</span>&gt; as &lt;<span style="font-style: italic;">Format 
 Name</span>&gt; for outputting in a block. The &lt;<span style="font-style: italic;">Format 
 Name</span>&gt; must be defined in the Definition File.</p>

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

<p style="text-align: left; margin-left: 80px;"
	align=left>address name, format name</p>

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

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

<h1><a NAME=set_line></a>Set Line Leader</h1>

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

<p CLASS=ListBulletTxt><span style="font-weight: bold;">MOM_set_line_leader 
 &lt;Always | Once | Off &gt; </span><span style="font-style: italic;"><span 
 style="font-weight: bold;">&lt;&quot;string&quot;&gt;</span></span></p>

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

<p CLASS=ListBulletTxt>This function causes MOM to set the line leader 
 to <span style="font-style: italic;">string </span>with the indicated 
 status. If a line leader is to be output is output as the first characters 
 of the output line (i.e., before the SEQUENCE).</p>

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

<p CLASS=ListBulletTxt>modality attribute, string</p>

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

<p CLASS=ListBulletTxt>MOM_set_line_leader Always &quot;/&quot;</p>

<h1><a NAME=set_on></a>Set Sequence On</h1>

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

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

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

<p CLASS=ListBulletTxt>Allow output of the sequence number if a <span style="font-weight: bold;">SEQUENCE 
 </span>specifier was given in the definition file.Return the sequence 
 setting at the time the command is exectued.</p>

<p CLASS=ListBulletTxt
	style="margin-left: 40px;">eg. set current_status [MOM_set_seq_on]<br>
...<br>
if ($current_status = = &quot;off&quot;) {<br>
MOM_set_seq_off<br>
}</p>

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

<p CLASS=ListBulletTxt>none</p>

<h1><a NAME=set_off></a>Set Sequence Off</h1>

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

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

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

<p CLASS=ListBulletTxt>Do not output a sequence number. Return the sequence 
 setting at the time the command is exectued.</p>

<p CLASS=ListBulletTxt
	style="margin-left: 40px;">eg. set current_status [MOM_set_seq_off]<br>
...<br>
if ($current_status = = &quot;on&quot;) {<br>
MOM_set_seq_on<br>
}</p>

<p CLASS=ListBulletTxt
	style="margin-left: 40px;">&nbsp;</p>

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

<p CLASS=ListBulletTxt>None</p>

<h1><a NAME=suppress></a>Suppress</h1>

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

<p CLASS=ListBulletTxt><span style="font-weight: bold;">MOM_suppress &lt;Always 
 | Once | Off &gt; </span><span style="font-style: italic;"><span style="font-weight: bold;">&lt;Address_1 
 ... Address_n&gt;</span></span></p>

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

<p CLASS=ListBulletTxt>The next time that a block template that contains 
 a reference to any of the input address names is evaluated, the word that 
 contains the address will not be output regardless of its modality attribute.</p>

<div style="margin-left: 80px;">
<!--(Table)=========================================================-->
<!--begin!kadov{{--><div align=left><!--}}end!kadov-->
<table x-use-null-cells
		wrapperparagraphselector=P.CellDescrip
		style="border-spacing: 0px; float: alignleft;"
		cellspacing=0>

<tr>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellTopic
	style="text-align: left; margin-bottom: 0;"
	align=left>User</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p>&nbsp;</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellTopic
	style="text-align: left; margin-bottom: 0;"
	align=left>MOM Architecture</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p>&nbsp;</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p>&nbsp;</td></tr>

<tr>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellDescrip
	style="text-align: left; margin-bottom: 0;"
	align=left>MOM_suppress</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellDescrip
	style="text-align: left; margin-bottom: 0;"
	align=left>ONCE----&gt;</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellDescrip
	style="text-align: left; margin-bottom: 0;"
	align=left>MOM_force<br>
MOM_suppress</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellDescrip
	style="text-align: left; margin-bottom: 0;"
	align=left>ONCE----&gt;<br>
ONCE----&gt;</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellDescrip
	style="text-align: left; margin-bottom: 0;"
	align=left>False<br>
True</td></tr>

<tr>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellDescrip
	style="text-align: left; margin-bottom: 0;"
	align=left>MOM_suppress</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellDescrip
	style="text-align: left; margin-bottom: 0;"
	align=left>OFF----&gt;</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellDescrip
	style="text-align: left; margin-bottom: 0;"
	align=left>MOM_supress is set to</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellDescrip
	style="text-align: left; margin-bottom: 0;"
	align=left>OFF</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p>&nbsp;</td></tr>

<tr>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellDescrip
	style="text-align: left; margin-bottom: 0;"
	align=left>MOM_supress</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellDescrip
	style="text-align: left; margin-bottom: 0;"
	align=left>ALWAYS----&gt;</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellDescrip
	style="text-align: left; margin-bottom: 0;"
	align=left>MOM_force<br>
MOM_suppress is set to</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p CLASS=CellDescrip
	style="text-align: left; margin-bottom: 0;"
	align=left>OFF<br>
ALWAYS</td>
<td style="x-cell-content-align: TOP;
			padding-left: 2px;
			padding-top: 2px;
			padding-right: 2px;
			padding-bottom: 2px;"
	valign=top>
<p>&nbsp;</td></tr>
</table>
<!--begin!kadov{{--></div><!--}}end!kadov-->
</div>

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

<p CLASS=ListBulletTxt>modality attribute, address names</p>

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

<p CLASS=ListBulletTxt
	style="margin-bottom: 0;">MOM_suppress_address Always N X Y </p>

<p CLASS=ListBulletTxt
	style="margin-bottom: 0;">&nbsp;</p>

<h5>Address output with MOM_suppress OFF programmed in tcl (default state)</h5>

<!--(Table)=========================================================-->
<table x-use-null-cells
		style="x-cell-content-align: top; border-spacing: 3px;"
		cellspacing=3>
<col>
<col>
<col>
<col>

<tr valign=top>
<td style="padding-right: 10px;
			padding-left: 10px;
			background-color: #f2f2f2;
			border-left-style: none;
			border-right-style: none;
			border-bottom-style: none;
			border-top-style: none;"
	bgcolor=#F2F2F2>
<p>&nbsp;</td>
<td rowspan=1
	colspan=3
	style="padding-right: 10px;
			padding-left: 10px;
			background-color: #f2f2f2;
			border-right-style: none;
			border-bottom-style: none;
			border-top-style: none;"
	bgcolor=#F2F2F2>
<p class=ListBulletTxt
	style="margin-bottom: 0;">Programmed in tcl</td>
<td_null>
<td_null></tr>

<tr valign=top>
<td style="padding-right: 10px;
			padding-left: 10px;
			background-color: #f2f2f2;
			border-right-style: none;
			border-bottom-style: none;
			border-left-style: none;"
	bgcolor=#F2F2F2>
<p>Definition file</td>
<td style="padding-right: 10px;
			padding-left: 10px;
			background-color: #f2f2f2;
			border-right-style: none;
			border-bottom-style: none;"
	bgcolor=#F2F2F2>
<p>MOM_force ONCE</td>
<td style="padding-right: 10px;
			padding-left: 10px;
			background-color: #f2f2f2;
			border-right-style: none;
			border-bottom-style: none;"
	bgcolor=#F2F2F2>
<p>MOM_suppress ONCE</td>
<td style="padding-right: 10px;
			padding-left: 10px;
			background-color: #f2f2f2;
			border-right-style: none;
			border-bottom-style: none;"
	bgcolor=#F2F2F2>
<p><!--kadov_tag{{<spaces>}}-->&nbsp;<!--kadov_tag{{</spaces>}}-->Neither</td></tr>

<tr valign=top>
<td colspan=1
	rowspan=1
	style="padding-right: 10px;
			padding-left: 10px;
			background-color: #f2f2f2;
			border-right-style: none;
			border-bottom-style: none;
			border-left-style: none;"
	bgcolor=#F2F2F2>
<p>Force OFF(modal)</td>
<td colspan=1
	rowspan=1
	style="padding-right: 10px;
			padding-left: 10px;
			background-color: #f2f2f2;
			border-right-style: none;
			border-bottom-style: none;"
	bgcolor=#F2F2F2>
<p>Yes </td>
<td colspan=1
	rowspan=1
	style="padding-right: 10px;
			padding-left: 10px;
			background-color: #f2f2f2;
			border-right-style: none;
			border-bottom-style: none;"
	bgcolor=#F2F2F2>
<p>No</td>
<td colspan=1
	rowspan=1
	style="padding-right: 10px;
			padding-left: 10px;
			background-color: #f2f2f2;
			border-right-style: none;
			border-bottom-style: none;"
	bgcolor=#F2F2F2>
<p>If different</td></tr>

<tr valign=top>
<td style="padding-right: 10px;
			padding-left: 10px;
			background-color: #f2f2f2;
			border-right-style: none;
			border-bottom-style: none;
			border-left-style: none;"
	bgcolor=#F2F2F2>
<p>Force ALWAYS(non-modal)</td>
<td style="padding-right: 10px;
			padding-left: 10px;
			background-color: #f2f2f2;
			border-right-style: none;
			border-bottom-style: none;"
	bgcolor=#F2F2F2>
<p>Yes </td>
<td style="padding-right: 10px;
			padding-left: 10px;
			background-color: #f2f2f2;
			border-right-style: none;
			border-bottom-style: none;"
	bgcolor=#F2F2F2>
<p>No</td>
<td style="padding-right: 10px;
			padding-left: 10px;
			background-color: #f2f2f2;
			border-right-style: none;
			border-bottom-style: none;"
	bgcolor=#F2F2F2>
<p>Yes</td></tr>
</table>

<p class=ListBulletTxt
	style="margin-bottom: 0;">&nbsp;</p>

<p class=ListBulletTxt
	style="margin-bottom: 0;">If both MOM_force ONCE and MOM_suppress once 
 are programmed, the last one will take effect.</p>

<p class=ListBulletTxt
	style="margin-bottom: 0;">If MOM_suppress ALWAYS is programmed, the 
 address will never be output. All MOM_force ONCE and MOM_suppress ONCE 
 commands are ignored. </p>

<p class=ListBulletTxt
	style="margin-bottom: 0;">In the definition file, Force OFF or Force 
 ALWAYS should define the modality of the address. Using MOM_force OFF 
 or MOM_force ALWAYS to redefine the modality in the tcl is not recommended.</p>

</body>

</html>
