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

<html>

<head>
<title>NaturalAccess GR303 and V5 Libraries Developer's Manual: Using the NMS V5 function reference</title>
<meta http-equiv="content-type" content="text/html; charset=windows-1252">
<meta name=NMSConversion content="4.0.8">
<meta name="generator" content="RoboHelp by eHelp Corporation www.ehelp.com">
<link rel="stylesheet" href="dialogic_ns.css"><script type="text/javascript" language="JavaScript" title="WebHelpSplitCss">
<!--
if (navigator.appName !="Netscape")
{   document.write("<link rel='stylesheet' href='dialogic.css'>");}
//-->
</script>
<style type="text/css">
<!--
table.whs1 {   x-border-left:1px table-solid; x-border-top:1px table-solid; x-border-right:1px table-solid; x-border-bottom:1px table-solid; border-collapse:separate; border-spacing:0px; width:100%; }
col.whs2 { width:14.366%; }
col.whs3 { width:85.634%; }
tr.whs4 { x-cell-content-align:top; vertical-align:top; }
td.whs5 { vertical-align:top; padding-left:5px;  padding-right:5px;  }
p.whs6 { font-weight:bold; }
div.whs7 { width:100%; }
p.whs8 { text-align:center; }
p.whs9 { text-align:center; font-size:xx-small; }
-->
</style><script type="text/javascript" language="JavaScript">
<!--
if ((navigator.appName == "Netscape") && (parseInt(navigator.appVersion) == 4))
{
  var strNSS = "<style type='text/css'>";
  strNSS += "p.whs9 {font-size:x-small; }";
  strNSS +="</style>";
  document.write(strNSS);
}
//-->
</script>
<script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">
<!--
function reDo() {
  if (innerWidth != origWidth || innerHeight != origHeight)
     location.reload();
}
if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {
	origWidth = innerWidth;
	origHeight = innerHeight;
	onresize = reDo;
}
onerror = null; 
//-->
</script>
<style type="text/css">
<!--
div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }
-->
</style><script type="text/javascript" language="javascript1.2" src="whmsg.js"></script>
<script type="text/javascript" language="javascript" src="whver.js"></script>
<script type="text/javascript" language="javascript1.2" src="whproxy.js"></script>
<script type="text/javascript" language="javascript1.2" src="whutils.js"></script>
<script type="text/javascript" language="javascript1.2" src="whtopic.js"></script>
</head>
<body><script type="text/javascript" language="javascript1.2">
<!--
if (window.gbWhTopic)
{
	if (window.addTocInfo)
	{
	addTocInfo("NMS V5 function reference\nUsing the function reference");
addAvenueInfo("Untitled","nms_v5_library_function_summary_.htm","nmsv5addchannel.html");
addButton("show",BTN_TEXT,"Show table of contents for this manual","","","","",0,0,"","","");

	}
	if (window.writeBtnStyle)
		writeBtnStyle();

	if (window.writeIntopicBar)
		writeIntopicBar(1);

	if (window.setRelStartPage)
	{
	setRelStartPage("default.htm");

		autoSync(1);
		sendSyncInfo();
		sendAveInfoOut();
	}
}
else
	if (window.gbIE4)
		document.location.reload();
//-->
</script>
<h1>Using the function reference</h1>

<p>This section provides an alphabetical reference to the NMS V5 functions. 
 A prototype of each function is shown with the function description and 
 details of all its arguments and return values. A typical function includes:</p>

<table cellpadding="5" x-use-null-cells width="100%" cellspacing="0" border="1" class="whs1">
<col class="whs2">
<col class="whs3">

<tr valign="top" class="whs4">
<td width="14.366%" class="whs5">
<p class="whs6">Prototype</p></td>
<td width="85.634%" class="whs5">
<p>The prototype is followed by a list of the function's arguments. NMS 
 data types include:</p>
<ul>
	
	<li class=kadov-p-CCellBodyBullet1><p class=CellBodyBullet1><span style="color: #000000;
	font-style: normal;
	font-weight: normal;
	x-text-underline: off;
	x-text-overline: off;
	x-text-line-through: off;
	text-transform: none;
	vertical-align: baseline;
	/*begin!kadov{{*/ text-decoration: none none none; /*}}end!kadov*/ "><font color=black >WORD 
 (</font></span>16- bit unsigned)</p></li>
	
	<li class=kadov-p-CCellBodyBullet1><p class=CellBodyBullet1><span style="color: #000000;
	font-style: normal;
	font-weight: normal;
	x-text-underline: off;
	x-text-overline: off;
	x-text-line-through: off;
	text-transform: none;
	vertical-align: baseline;
	/*begin!kadov{{*/ text-decoration: none none none; /*}}end!kadov*/ "><font color=black >DWORD 
 (</font></span>32-bit unsigned)</p></li>
	
	<li class=kadov-p-CCellBodyBullet1><p class=CellBodyBullet1><span style="color: #000000;
	font-style: normal;
	font-weight: normal;
	x-text-underline: off;
	x-text-overline: off;
	x-text-line-through: off;
	text-transform: none;
	vertical-align: baseline;
	/*begin!kadov{{*/ text-decoration: none none none; /*}}end!kadov*/ "><font color=black >INT16 
 (</font></span>16-bit signed)</p></li>
	
	<li class=kadov-p-CCellBodyBullet1><p class=CellBodyBullet1><span style="color: #000000;
	font-style: normal;
	font-weight: normal;
	x-text-underline: off;
	x-text-overline: off;
	x-text-line-through: off;
	text-transform: none;
	vertical-align: baseline;
	/*begin!kadov{{*/ text-decoration: none none none; /*}}end!kadov*/ "><font color=black >INT32 
 (</font></span>32-bit signed)</p></li>
	
	<li class=kadov-p-CCellBodyBullet1><p class=CellBodyBullet1><span style="color: #000000;
	font-style: normal;
	font-weight: normal;
	x-text-underline: off;
	x-text-overline: off;
	x-text-line-through: off;
	text-transform: none;
	vertical-align: baseline;
	/*begin!kadov{{*/ text-decoration: none none none; /*}}end!kadov*/ "><font color=black >BYTE 
 (</font></span>8-bit unsigned)</p></li>
</ul>
<p>If a function argument is a data structure, the complete data structure 
 is defined. For more information, refer to the Data types overview.</p></td></tr>

<tr valign="top" class="whs4">
<td width="14.366%" class="whs5">
<p class="whs6">Return values</p>
<p>and </p>
<p class="whs6">Events</p></td>
<td width="85.634%" class="whs5">
<p>The return value for a function is either <span style="color: #000000;
															font-style: normal;
															font-weight: normal;
															x-text-underline: off;
															x-text-overline: off;
															x-text-line-through: off;
															text-transform: none;
															vertical-align: baseline;
															/*begin!kadov{{*/ text-decoration: none none none; /*}}end!kadov*/ "><font color=black >SUCCESS</font></span> 
 or an error code. For asynchronous functions, a return value of <span 
 style="color: #000000;
		font-style: normal;
		font-weight: normal;
		x-text-underline: off;
		x-text-overline: off;
		x-text-line-through: off;
		text-transform: none;
		vertical-align: baseline;
		/*begin!kadov{{*/ text-decoration: none none none; /*}}end!kadov*/ "><font color=black >SUCCESS</font></span> 
 indicates the function was initiated; subsequent events indicate the status 
 of the operation.</p>
<p>For more information about errors, refer to <a HREF="nms_v5_library_errors_.htm">NMS 
 V5 library errors</a>.</p>
<p>For more information about events, refer to <a href="nms_v5_library_channel_callback_events_.htm">NMS 
 V5 library channel callback events</a>.</p></td></tr>

<tr valign="top" class="whs4">
<td colspan="1" rowspan="1" width="14.366%" class="whs5">
<p class="whs6">Example</p></td>
<td colspan="1" rowspan="1" width="85.634%" class="whs5">
<p class=CellBody>Example functions are excerpts taken from sample application 
 programs shipped with the product.</p>
<p class=CellBody>The notation <span class=ExampleChar>/* ... */</span> 
 indicates additional code that is not shown.</p></td></tr>
</table><br>

<div placeholder id="footer" class="whs7">
 <p align="center" class="whs8">&nbsp;</p>
 <p align="center" class="whs8"><script type="text/javascript" language="JavaScript1.2">var mailSubject = 'Documentation link: ' + document.title;
var mailBody = 'Link to reference this topic:%0A %0A' + location.href;
var mailDisplay = '<img src="send_link.gif" border="0" alt="Send link to this topic">'; 
document.write( 
'<a href="mailto:Enter recipient email address' 
+ '?subject=' + escape(mailSubject) 
+ '&body=' + (mailBody) 
+ '">' + mailDisplay + '</a>' 
);</script></p>
 <p align="center" class="whs9">&#169; 
 Copyright 2009 Dialogic Corporation. All rights reserved.</p>
</div>
<script type="text/javascript" language="javascript1.2">
<!--
if (window.writeIntopicBar)
	writeIntopicBar(0);
//-->
</script>
</body>
</html>

