php-doc-en/functions/notes.xml
Hartmut Holzgraefe 4c31e191c5 en Upgrade to DocBook4
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@69281 c90b9560-bf6c-de11-be94-00142212c4b1
2002-02-02 15:36:11 +00:00

303 lines
9.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<reference id="ref.notes">
<title>Lotus Notes functions</title>
<titleabbrev>Lotus Notes</titleabbrev>
<partintro>
<para>
&warn.experimental;
</para>
</partintro>
<refentry id="function.notes-create-db">
<refnamediv>
<refname>notes_create_db</refname>
<refpurpose>Create a Lotus Notes database </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>notes_create_db</methodname>
<methodparam><type>string</type><parameter>database_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.notes-drop-db">
<refnamediv>
<refname>notes_drop_db</refname>
<refpurpose>Drop a Lotus Notes database </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>notes_drop_db</methodname>
<methodparam><type>string</type><parameter>database_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.notes-version">
<refnamediv>
<refname>notes_version</refname>
<refpurpose>Get the version Lotus Notes </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>notes_version</methodname>
<methodparam><type>string</type><parameter>database_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.notes-create-note">
<refnamediv>
<refname>notes_create_note</refname>
<refpurpose>Create a note using form form_name </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>notes_create_note</methodname>
<methodparam><type>string</type><parameter>database_name</parameter></methodparam>
<methodparam><type>string</type><parameter>form_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.notes-mark-read">
<refnamediv>
<refname>notes_mark_read</refname>
<refpurpose>Mark a note_id as read for the User user_name</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>notes_mark_read</methodname>
<methodparam><type>string</type><parameter>database_name</parameter></methodparam>
<methodparam><type>string</type><parameter>user_name</parameter></methodparam>
<methodparam><type>string</type><parameter>note_id</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.notes-mark-unread">
<refnamediv>
<refname>notes_mark_unread</refname>
<refpurpose>Mark a note_id as unread for the User user_name</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>notes_mark_unread</methodname>
<methodparam><type>string</type><parameter>database_name</parameter></methodparam>
<methodparam><type>string</type><parameter>user_name</parameter></methodparam>
<methodparam><type>string</type><parameter>note_id</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.notes-unread">
<refnamediv>
<refname>notes_unread</refname>
<refpurpose>Returns the unread note id's for the current User user_name</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>notes_unread</methodname>
<methodparam><type>string</type><parameter>database_name</parameter></methodparam>
<methodparam><type>string</type><parameter>user_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.notes-header-info">
<refnamediv>
<refname>notes_header_info</refname>
<refpurpose>Open the message msg_number in the specified mailbox on the specified server (leave serv</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>object</type><methodname>notes_header_info</methodname>
<methodparam><type>string</type><parameter>server</parameter></methodparam>
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
<methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.notes-body">
<refnamediv>
<refname>notes_body</refname>
<refpurpose>Open the message msg_number in the specified mailbox on the specified server (leave serv</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>notes_body</methodname>
<methodparam><type>string</type><parameter>server</parameter></methodparam>
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
<methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.notes-find-note">
<refnamediv>
<refname>notes_find_note</refname>
<refpurpose>Returns a note id found in database_name. Specify the name of the note. Leaving type bla</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>notes_find_note</methodname>
<methodparam><type>string</type><parameter>database_name</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.notes-nav-create">
<refnamediv>
<refname>notes_nav_create</refname>
<refpurpose>Create a navigator name, in database_name </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>notes_nav_create</methodname>
<methodparam><type>string</type><parameter>database_name</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.notes-search">
<refnamediv>
<refname>notes_search</refname>
<refpurpose>Find notes that match keywords in database_name</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>notes_search</methodname>
<methodparam><type>string</type><parameter>database_name</parameter></methodparam>
<methodparam><type>string</type><parameter>keywords</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.notes-copy-db">
<refnamediv>
<refname>notes_copy_db</refname>
<refpurpose>title]) Create a note using form form_name </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>notes_copy_db</methodname>
<methodparam><type>string</type><parameter>from_database_name</parameter></methodparam>
<methodparam><type>string</type><parameter>to_database_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.notes-list-msgs">
<refnamediv>
<refname>notes_list_msgs</refname>
<refpurpose>Returns the notes from a selected database_name</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>notes_list_msgs</methodname>
<methodparam><type>string</type><parameter>db</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->