<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head profile="http://internetalchemy.org/2003/02/profile">
<link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" />
<link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" />
<meta name="dc.title" content="Function: nntp_get - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: nntp_get - Virtuoso Functions Guide" />
<meta name="dc.creator" content="OpenLink Software Documentation Team ; " />
<meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" />
<link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" />
<link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" />
<link rel="parent" href="functions.html" title="Chapter Contents" />
<link rel="prev" href="appendixa.html" title="Appendix" />
<link rel="next" href="functions.html#.html" title="" />
<link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" />
<link rel="stylesheet" type="text/css" href="doc.css" />
<link rel="stylesheet" type="text/css" href="/doc/translation.css" />
<title>Function: nntp_get - Virtuoso Functions Guide</title>
<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
<meta name="author" content="OpenLink Software Documentation Team ; " />
<meta name="copyright" content="OpenLink Software, 1999 - 2009" />
<meta name="keywords" content="" />
<meta name="GENERATOR" content="OpenLink XSLT Team" />
</head>
<body>
<div id="header">
<a name="fn_nntp_get" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - nntp_get</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_nntp_auth_post.html" title="nntp_auth_post">Prev</a> | <a class="link" href="fn_nntp_post.html" title="nntp_post">Next</a>
</div>
</div>
<div id="currenttoc">
<form method="post" action="/doc/adv_search.vspx">
<div class="search">Keyword Search: <br />
<input type="text" name="q" /> <input type="submit" name="go" value="Go" />
</div>
</form>
<div>
<a href="http://www.openlinksw.com/">www.openlinksw.com</a>
</div>
<div>
<a href="http://docs.openlinksw.com/">docs.openlinksw.com</a>
</div>
<br />
<div>
<a href="index.html">Book Home</a>
</div>
<br />
<div>
<a href="contents.html">Contents</a>
</div>
<div>
<a href="preface.html">Preface</a>
</div>
<br />
<div>
<a class="selected" href="functions.html">Virtuoso Functions Guide</a>
</div>
<br />
<div>
<a href="functions.html#admin">Administration</a>
</div>
<div>
<a href="functions.html#aggr">Aggregate Functions</a>
</div>
<div>
<a href="functions.html#array">Array Manipulation</a>
</div>
<div>
<a href="functions.html#bpel">BPEL APIs</a>
</div>
<div>
<a href="functions.html#backup">Backup</a>
</div>
<div>
<a href="functions.html#compression">Compression</a>
</div>
<div>
<a href="functions.html#cursors">Cursor</a>
</div>
<div>
<a href="functions.html#time">Date & Time Manipulation</a>
</div>
<div>
<a href="functions.html#debug">Debug</a>
</div>
<div>
<a href="functions.html#dict">Dictionary Manipulation</a>
</div>
<div>
<a href="functions.html#encoding">Encoding & Decoding</a>
</div>
<div>
<a href="functions.html#file">File Manipulation</a>
</div>
<div>
<a href="functions.html#ft">Free Text</a>
</div>
<div>
<a href="functions.html#hash">Hashing / Cryptographic</a>
</div>
<div>
<a href="functions.html#ldap">LDAP</a>
</div>
<div>
<a href="functions.html#localization">Locale</a>
</div>
<div>
<a class="selected" href="functions.html#mail">Mail</a>
</div>
<div class="selected">
<div>
<a href="fn_mime_body.html">mime_body</a>
</div>
<div>
<a href="fn_mime_part.html">mime_part</a>
</div>
<div>
<a href="fn_mime_tree.html">mime_tree</a>
</div>
<div>
<a href="fn_nntp_auth_get.html">nntp_auth_get</a>
</div>
<div>
<a href="fn_nntp_auth_post.html">nntp_auth_post</a>
</div>
<div>
<a class="selected" href="fn_nntp_get.html">nntp_get</a>
</div>
<div>
<a href="fn_nntp_post.html">nntp_post</a>
</div>
<div>
<a href="fn_pem_certificates_to_array.html">pem_certificates_to_...</a>
</div>
<div>
<a href="fn_pop3_get.html">pop3_get</a>
</div>
<div>
<a href="fn_smime_decrypt.html">smime_decrypt</a>
</div>
<div>
<a href="fn_smime_encrypt.html">smime_encrypt</a>
</div>
<div>
<a href="fn_smime_sign.html">smime_sign</a>
</div>
<div>
<a href="fn_smime_verify.html">smime_verify</a>
</div>
<div>
<a href="fn_smtp_send.html">smtp_send</a>
</div>
<div>
<a href="fn_uuvalidate.html">uuvalidate</a>
</div>
</div>
<div>
<a href="functions.html#misc">Miscellaneous</a>
</div>
<div>
<a href="functions.html#number">Number</a>
</div>
<div>
<a href="functions.html#phrz">Phrases</a>
</div>
<div>
<a href="functions.html#rdf">RDF data</a>
</div>
<div>
<a href="functions.html#rmt">Remote SQL Data Source</a>
</div>
<div>
<a href="functions.html#repl">Replication</a>
</div>
<div>
<a href="functions.html#soap">SOAP</a>
</div>
<div>
<a href="functions.html#sql">SQL</a>
</div>
<div>
<a href="functions.html#string">String</a>
</div>
<div>
<a href="functions.html#txn">Transaction</a>
</div>
<div>
<a href="functions.html#type">Type Mapping</a>
</div>
<div>
<a href="functions.html#uddi">UDDI</a>
</div>
<div>
<a href="functions.html#udt">User Defined Types & The CLR</a>
</div>
<div>
<a href="functions.html#vad">VAD</a>
</div>
<div>
<a href="functions.html#jvmpl">Virtuoso Java PL API</a>
</div>
<div>
<a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a>
</div>
<div>
<a href="functions.html#ws">Web & Internet</a>
</div>
<div>
<a href="functions.html#xml">XML</a>
</div>
<div>
<a href="functions.html#XPATH">XPATH & XQUERY</a>
</div>
<br />
<div>
<a href="functionidx.html">Functions Index</a>
</div>
<br />
</div>
<div id="text">
<h2>nntp_get</h2>
<div class="refpurpose">Returns information about an NNTP server.</div>
<div class="funcsynopsis">
<span class="funcdef">array <span class="function">nntp_get</span>
</span>
(<span class="paramdef">in <span class="parameter">server</span> varchar</span>,
<span class="paramdef">in <span class="parameter">command</span> varchar</span>,
<span class="paramdef">in <span class="parameter">group</span> varchar</span>,
<span class="paramdefoptional">[in <span class="optional">first_message</span> integer]</span>,
<span class="paramdefoptional">[in <span class="optional">last_message</span> integer]</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>
<span class="computeroutput">nntp_get()</span> is used to retrieve messages from a server running
the Network News Transfer Protocol (NNTP) as defined in
<a href="http://www.rfc-editor.org/rfc/rfc977.txt">RFC977</a>. It returns
an array whose structure depends on the <span class="computeroutput">command</span>
parameter, thus:</p>
<ul>
<li>
<strong>list</strong>: an array of vectors, each of which
contain the name of the news group, the first message number, the last
message number, and a single character 'y' or 'n' as a flag for
posting.</li>
<li>
<strong>group</strong>: a vector of three elements: total number
of messages in the group, the number of the first message, and the number
of the last message.</li>
<li>
<strong>stat</strong>: an array of vectors, each of which
contains the number of the message and the message id.</li>
<li>
<strong>article, body, head</strong>: an array of vectors each
containing the message number and the requested part of the message.</li>
</ul>
</div>
<div class="refsect1">
<div class="refsect1title">Parameters</div>
<div class="refsect2">
<span class="refsect2title">server – </span>
The IP address or <hostname:port> of the host with which to
connect. There is no default for <span class="computeroutput">port</span>, so to connect to the
standard port for NNTP, use <hostname/IP address>:119.
</div>
<div class="refsect2">
<span class="refsect2title">command – </span>
Command <span class="computeroutput">string</span>. Valid values are:
<ul>
<li>article</li>
<li>body</li>
<li>head</li>
<li>stat</li>
<li>list</li>
<li>group</li>
<li>xover</li>
</ul>
</div>
<div class="refsect2">
<span class="refsect2title">group – </span>
A <span class="computeroutput">string</span> containing the name of the newsgroup.
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Return Types</div>
<p>A vector of vectors the content of which depends on the
<span class="computeroutput">command</span> parameter.</p>
</div>
<div class="refsect1title">Errors</div>
<table class="data">
<tr>
<th class="data">SQLState</th>
<th class="data">Error Code</th>
<th class="data">Error Text</th>
</tr>
<tr>
<td class="data">
<a name="err22023" />
<span class="errorcode">22023</span>
</td>
<td class="data">
<a name="errNN006" />
<span class="errorcode">NN006</span>
</td>
<td class="data">
<span class="errorname">the command is not recognized</span>
</td>
</tr>
<tr>
<td class="data">
<a name="err22023" />
<span class="errorcode">22023</span>
</td>
<td class="data">
<a name="errNN001" />
<span class="errorcode">NN001</span>
</td>
<td class="data">
<span class="errorname">Large ID in nntp_id_get</span>
</td>
</tr>
<tr>
<td class="data">
<a name="err2E000" />
<span class="errorcode">2E000</span>
</td>
<td class="data">
<a name="errNN002" />
<span class="errorcode">NN002</span>
</td>
<td class="data">
<span class="errorname">Invalid address for News Server at [host]</span>
</td>
</tr>
<tr>
<td class="data">
<a name="err08001" />
<span class="errorcode">08001</span>
</td>
<td class="data">
<a name="errNN003" />
<span class="errorcode">NN003</span>
</td>
<td class="data">
<span class="errorname">Unable to Contact News Server at [host]</span>
</td>
</tr>
<tr>
<td class="data">
<a name="err08006" />
<span class="errorcode">08006</span>
</td>
<td class="data">
<a name="errNN004" />
<span class="errorcode">NN004</span>
</td>
<td class="data">
<span class="errorname">Lost connection with NNTP server</span>
</td>
</tr>
<tr>
<td class="data">
<a name="err08006" />
<span class="errorcode">08006</span>
</td>
<td class="data">
<a name="errNN005" />
<span class="errorcode">NN005</span>
</td>
<td class="data">
<span class="errorname">Misc. error in connection in nntp_get</span>
</td>
</tr>
</table>
<br />
<p />
<div class="refsect1">
<div class="refsect1title">Examples</div>
<a name="ex_nntp_get_1" />
<div class="example">
<div class="exampletitle">Get remote messages</div>
<p>This example retrieves messages from a remote NNTP server and stores them in a table.</p>
<div>
<pre class="screen">
create table my_news (m_id integer, m_group varchar, m_text long varchar,
primary key (m_id, m_group));
create procedure get_my_news (in server varchar, in grp varchar)
{
declare res, ent any;
declare i, l integer;
res := nntp_get (server, 'article', grp, 0, 1000);
i := 0; l := length (res);
while (i < l)
{
ent := res [i];
insert replacing my_news (m_id, m_group, m_text)
values (ent[0], grp, ent[1]);
i := i + 1;
}
}
</pre>
</div>
<p>Here is a test run. We extract the article subject with the <span class="computeroutput">mail_header()</span> function.</p>
<div>
<pre class="screen">
SQL> get_my_news ('news.techno-link.com:119', 'comp.lang.java.api');
SQL> select m_id, mail_header (m_text, 'Subject') from my_news;
m_id callret
INTEGER NOT NULL VARCHAR
_______________________________________________________________________________
2 New java method modifier "partial": not quite abstract, not quite concrete
3 Senior Design Project Ideas
4 java & dummy terminals
5 Re: What is the equivalent of WORD in Java
6 Re: What is the equivalent of WORD in Java
</pre>
</div>
</div>
</div>
</div>
<div id="footer">
<div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div>
<div id="validation">
<a href="http://validator.w3.org/check/referer">
<img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" />
</a>
<a href="http://jigsaw.w3.org/css-validator/">
<img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" />
</a>
</div>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
71d40963b505df4524269198e237b3e3
>
files
>
416
