File: tapi-ch4.htm

package info (click to toggle)
aolserver 3.4.2-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 22,692 kB
  • ctags: 33,612
  • sloc: ansic: 171,340; tcl: 10,218; sh: 3,821; cpp: 2,779; makefile: 2,041; yacc: 1,648; perl: 456; php: 13
file content (75 lines) | stat: -rw-r--r-- 3,275 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<HTML><HEAD>
<TITLE>Tcl API Reference -- ns_adp_abort</TITLE>
<LINK rel=Previous href="tapi-ch3.htm">
<LINK rel=ToC href="toc.htm">
<LINK rel=Index href="master.htm">
<LINK rel=Next href="tapi-ch5.htm">
</HEAD><BODY BGCOLOR="#ffffff"><A NAME="topofpage"></A>
<TABLE WIDTH=100%>
  <TR>
    <TD ALIGN=LEFT>
      <A NAME="topofpage"></A> <IMG  SRC="as-c-sm.gif">
    </TD>
    <TD ALIGN=RIGHT>
      <A href="tapi-ch3.htm"><IMG  BORDER="0" src=navbprev.gif alt="[ Previous ]"></A>
      <A href=toc.htm> <IMG  BORDER="0" src=navbhome.gif alt="[ Contents ]"></A>
      <A href=master.htm> <IMG  BORDER="0" src=navbhelp.gif alt="[ Index ]"></A>
      <A href="tapi-ch5.htm"> <IMG  BORDER="0" src=navbnext.gif alt="[ Next ]"></A>
      <A name="7983"> </A>
    </TD>
  </TR>
</TABLE>

<a name="145894">
</a><h3>ns_adp_abort</h3>
<a name="145895">
</a><h4>Overview</h4>
<p><a name="145896">
</a>Stop processing of ADP and throw away all output</p>
<a name="145897">
</a><h4>Syntax</h4>
<p><a name="145898">
</a><b>ns_adp_abort </b>?<i>return_value</i>?</p>
<a name="145899">
</a><h4>Description</h4>
<p><a name="146957">
</a>This function aborts processing of the ADP file and any pending output up to that point is deleted. However, if a streaming script was processed before <b>ns_adp_abort</b> was called, the data will already have been output. Also, if any functions that cause output (such as <b>ns_return</b> or <b>ns_write</b>) were called before <b>ns_adp_abort</b>, their output will already have been output also.</p>
<p><a name="216553">
</a><b>ns_adp_abort</b> closes the connection without returning an empty HTML page. Every <b>ns_return</b><i>xxx</i> call in an ADP should be followed with a call to <b>ns_adp_abort</b>.</p>
<p><a name="216535">
</a>The <i>return_value</i>, if specified, becomes the return value of the ADP.</p>
<p><a name="296626">
</a>Note that this function returns all the way up the call stack. For example, suppose a.adp includes b.adp which includes c.adp, and c.adp calls <b>ns_adp_abort</b>. No code in b.adp or a.adp after the includes will be executed. You can get around this in one of two ways:</p>
<ul><li>You can execute these calls in a.adp and b.adp, respectively:<a name="296631">
</a>
<p><pre>    <a name="296640"></a>catch {ns_adp_include b.adp} retval
    <a name="296647"></a>catch {ns_adp_include c.adp} retval
</pre><p><li>Or, you can execute this call in c.adp:<a name="296636">
</a>
<p><pre>    <a name="296643"></a>ns_adp_return ?retval?
</pre><p><dl>
<dt>The <b>ns_adp_return</b> function returns up only one level.<a name="296644">
</a>
<p></dl>
</ul>

<TABLE BORDER="2" CELLPADDING="1" width="100%">
<TR><TD COLSPAN=3><P ALIGN=Center>
<IMG SRC="bluebult.gif">
<A HREF="#topofpage">
<FONT SIZE=-1>Top of Page</FONT></A>
<IMG SRC="bluebult.gif">
</TD></TR>
<TR><TD COLSPAN=3><P ALIGN=Center>
<A href="tapi-ch3.htm">
<IMG  BORDER="0" src=navbprev.gif alt="[ Previous ]"></A>
<A href=toc.htm>
<IMG  BORDER="0" src=navbhome.gif alt="[ Contents ]"></A>
<A href=master.htm>
<IMG  BORDER="0" src=navbhelp.gif alt="[ Index ]"></A>
<A href="tapi-ch5.htm">
<IMG  BORDER="0" src=navbnext.gif alt="[ Next ]"></A>
<BR align=center>
<FONT size=-1>Copyright &copy; 1998-99 America Online,
Inc.</FONT>
</TD></TR></TABLE></BODY></HTML>