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

<html>

<head>
<title>NaturalAccess GR303 and V5 Libraries Developer's Manual: NMS V5 library function summary </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:16.186%; }
col.whs3 { width:83.814%; }
tr.whs4 { background-color:#CCCCCC; x-cell-content-align:top; vertical-align:top; }
td.whs5 { vertical-align:top; padding-left:5px;  padding-right:5px;  }
p.whs6 { font-weight:bold; }
tr.whs7 { x-cell-content-align:top; vertical-align:top; }
table.whs8 {   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; }
col.whs9 { width:22.647%; }
col.whs10 { width:77.353%; }
div.whs11 { width:100%; }
p.whs12 { text-align:center; }
p.whs13 { 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.whs13 {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\nFunction summary");
addAvenueInfo("Untitled","nmsgr303stopinterface.html","using_the_nms_v5_function_reference.htm");
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>NMS V5 library function summary </h1>

<p>This topic summarizes NMS V5 library functions according to task. All 
 functions except <a href="nmsv5phsenddata.html"><span style="color: #0000ff;
	font-style: normal;
	font-weight: bold;
	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=blue ><B>NMS_V5PhSendData</B></font></span></a> 
 are synchronous.</p>

<h2>Initializing and exiting the NMS V5 library functions</h2>

<p>Use the following functions to initialize and exit the NMS V5 library 
 and to set trace levels for the library:</p>

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

<tr bgcolor="#CCCCCC" valign="top" class="whs4">
<td width="16.186%" class="whs5">
<p class="whs6">Function </p></td>
<td width="83.814%" class="whs5">
<p class="whs6">Description</p></td></tr>

<tr valign="top" class="whs7">
<td width="16.186%" class="whs5">
<p><a href="nmsv5initialize.html"><span style="color: #0000ff;
												font-style: normal;
												font-weight: bold;
												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=blue ><B>NMS_V5Initialize</B></font></span></a></p></td>
<td width="83.814%" class="whs5">
<p>Loads and initializes the NMS V5 library.</p></td></tr>

<tr valign="top" class="whs7">
<td width="16.186%" class="whs5">
<p><a href="nmsv5settrace.html"><span style="color: #0000ff;
												font-style: normal;
												font-weight: bold;
												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=blue ><B>NMS_V5SetTrace</B></font></span></a></p></td>
<td width="83.814%" class="whs5">
<p>Configures tracing for the NMS V5 library.</p></td></tr>

<tr valign="top" class="whs7">
<td width="16.186%" class="whs5">
<p><a href="nmsv5exit.html"><span style="color: #0000ff;
											font-style: normal;
											font-weight: bold;
											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=blue ><B>NMS_V5Exit</B></font></span></a></p></td>
<td width="83.814%" class="whs5">
<p>Performs an internal NMS V5 library clean-up procedure and exits the 
 library.</p></td></tr>
</table><br>

<h2>Creating and destroying interfaces functions</h2>

<p>Use the following functions to create and destroy primary and standby 
 variant physical layer interfaces, and to switch from primary interfaces 
 to standby variant interfaces: </p>

<table cellpadding="5" x-use-null-cells cellspacing="0" border="1" class="whs8">

<tr bgcolor="#CCCCCC" valign="top" class="whs4">
<td class="whs5">
<p class="whs6">Function </p></td>
<td class="whs5">
<p class="whs6">Description</p></td></tr>

<tr valign="top" class="whs7">
<td class="whs5">
<p><a href="nmsv5provisioninterface.html"><span style="color: #0000ff;
														font-style: normal;
														font-weight: bold;
														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=blue ><B>NMS_V5ProvisionInterface</B></font></span></a></p></td>
<td class="whs5">
<p>Configures (provisions) the HDLC channels for the specified interface.</p></td></tr>

<tr valign="top" class="whs7">
<td class="whs5">
<p><a href="nmsv5provisionstandbyvariant.html"><span style="color: #0000ff;
															font-style: normal;
															font-weight: bold;
															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=blue ><B>NMS_V5ProvisionStandByVariant</B></font></span></a></p></td>
<td class="whs5">
<p>Configures the HDLC channels and E1 links for an active variant on the 
 specified interface.</p></td></tr>

<tr valign="top" class="whs7">
<td class="whs5">
<p><a href="nmsv5destroyinterface.html"><span style="color: #0000ff;
														font-style: normal;
														font-weight: bold;
														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=blue ><B>NMS_V5DestroyInterface</B></font></span></a></p></td>
<td class="whs5">
<p>Destroys all connections for HDLC instances associated with a specified 
 interface.</p></td></tr>

<tr valign="top" class="whs7">
<td class="whs5">
<p><a href="nmsv5destroystandbyvariant.html"><span style="color: #0000ff;
															font-style: normal;
															font-weight: bold;
															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=blue ><B>NMS_V5DestroyStandByVariant</B></font></span></a></p></td>
<td class="whs5">
<p>Destroys a provisioned standby variant on the specified interface.</p></td></tr>

<tr valign="top" class="whs7">
<td class="whs5">
<p><a href="nmsv5switchovervariantdata.html"><span style="color: #0000ff;
															font-style: normal;
															font-weight: bold;
															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=blue ><B>NMS_V5SwitchOverVariantData</B></font></span></a></p></td>
<td class="whs5">
<p>Switches the interface to a specified standby variant.</p></td></tr>

<tr valign="top" class="whs7">
<td class="whs5">
<p><a href="nmsv5adde1.html"><span style="color: #0000ff;
											font-style: normal;
											font-weight: bold;
											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=blue ><B>NMS_V5AddE1</B></font></span></a></p></td>
<td class="whs5">
<p>Adds an E1 link associated with voice channels to a provisioned active 
 variant on a specified interface.</p></td></tr>

<tr valign="top" class="whs7">
<td class="whs5">
<p><a href="nmsv5deletee1.html"><span style="color: #0000ff;
												font-style: normal;
												font-weight: bold;
												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=blue ><B>NMS_V5DeleteE1</B></font></span></a></p></td>
<td class="whs5">
<p>Deletes an E1 link from an active variant of a provisioned interface.</p></td></tr>

<tr valign="top" class="whs7">
<td class="whs5">
<p><a href="nmsv5addchannel.html"><span style="color: #0000ff;
												font-style: normal;
												font-weight: bold;
												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=blue ><B>NMS_V5AddChannel</B></font></span></a></p></td>
<td class="whs5">
<p>Adds an HDLC channel (usually associated with an ISDN data channel) 
 to a provisioned active variant on a specified interface.</p></td></tr>

<tr valign="top" class="whs7">
<td class="whs5">
<p><a href="nmsv5deletechannel.html"><span style="color: #0000ff;
													font-style: normal;
													font-weight: bold;
													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=blue ><B>NMS_V5DeleteChannel</B></font></span></a></p></td>
<td class="whs5">
<p>Removes an HDLC channel from a provisioned active variant on a specified 
 interface.</p></td></tr>
</table><br>

<h2>Controlling interfaces functions</h2>

<p>Use the following functions to control physical layer interfaces with 
 the NMS V5 library:<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 ></font></span></p>

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

<tr bgcolor="#CCCCCC" valign="top" class="whs4">
<td width="22.647%" class="whs5">
<p class="whs6">Function </p></td>
<td width="77.353%" class="whs5">
<p class="whs6">Description</p></td></tr>

<tr valign="top" class="whs7">
<td width="22.647%" class="whs5">
<p><a href="nmsv5startinterface.html"><span style="color: #0000ff;
													font-style: normal;
													font-weight: bold;
													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=blue ><B>NMS_V5StartInterface</B></font></span></a></p></td>
<td width="77.353%" class="whs5">
<p>Starts the physical layer (HDLC channels) of the provisioned interface.</p></td></tr>

<tr valign="top" class="whs7">
<td width="22.647%" class="whs5">
<p><a href="nmsv5stopinterface.html"><span style="color: #0000ff;
													font-style: normal;
													font-weight: bold;
													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=blue ><B>NMS_V5StopInterface</B></font></span></a></p></td>
<td width="77.353%" class="whs5">
<p>Stops the physical layer of the provisioned interface.</p></td></tr>

<tr valign="top" class="whs7">
<td width="22.647%" class="whs5">
<p><a href="nmsv5phsenddata.html"><span style="color: #0000ff;
												font-style: normal;
												font-weight: bold;
												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=blue ><B>NMS_V5PhSendData</B></font></span></a></p></td>
<td width="77.353%" class="whs5">
<p>Sends a LAPV frame to a specified HDLC channel (asynchronous).</p></td></tr>

<tr valign="top" class="whs7">
<td width="22.647%" class="whs5">
<p><a href="nmsv5sendsa7bit.html"><span style="color: #0000ff;
												font-style: normal;
												font-weight: bold;
												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=blue ><B>NMS_V5SendSA7Bit</B></font></span></a></p></td>
<td width="77.353%" class="whs5">
<p>Sets the value of the SA7 E1 framing bit to 0 or 1.</p></td></tr>
</table><br>

<h2>Retrieving and resetting E1 link and channel information functions</h2>

<p>Use the following functions to retrieve and reset link status information 
 and channel statistics: </p>

<table cellpadding="5" x-use-null-cells cellspacing="0" border="1" class="whs8">

<tr bgcolor="#CCCCCC" valign="top" class="whs4">
<td class="whs5">
<p class="whs6">Function </p></td>
<td class="whs5">
<p class="whs6">Description</p></td></tr>

<tr valign="top" class="whs7">
<td class="whs5">
<p><a href="nmsv5gete1status.html"><span style="color: #0000ff;
												font-style: normal;
												font-weight: bold;
												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=blue ><B>NMS_V5GetE1Status</B></font></span></a></p></td>
<td class="whs5">
<p>Retrieves E1 link status information for a specified E1 link.</p></td></tr>

<tr valign="top" class="whs7">
<td class="whs5">
<p><a href="nmsv5resete1status.html"><span style="color: #0000ff;
													font-style: normal;
													font-weight: bold;
													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=blue ><B>NMS_V5ResetE1Status</B></font></span></a></p></td>
<td class="whs5">
<p>Resets E1 link status information for a specified E1 link.</p></td></tr>

<tr valign="top" class="whs7">
<td class="whs5">
<p><a href="nmsv5getchannelstatistics.html"><span style="color: #0000ff;
															font-style: normal;
															font-weight: bold;
															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=blue ><B>NMS_V5GetChannelStatistics</B></font></span></a></p></td>
<td class="whs5">
<p>Retrieves HDLC channel statistics for a specified HDLC channel on an 
 active provisioned interface.</p></td></tr>

<tr valign="top" class="whs7">
<td class="whs5">
<p><a href="nmsv5resetchannelstatistics.html"><span style="color: #0000ff;
															font-style: normal;
															font-weight: bold;
															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=blue ><B>NMS_V5ResetChannelStatistics</B></font></span></a></p></td>
<td class="whs5">
<p>Resets the HDLC channel statistics collected for a specified HDLC channel 
 provisioned on the active interface variant.</p></td></tr>
</table><br>

<div placeholder id="footer" class="whs11">
 <p align="center" class="whs12">&nbsp;</p>
 <p align="center" class="whs12"><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="whs13">&#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>

