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 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_metaWeblog.editPost">
<refmeta>
<refentrytitle>metaWeblog.editPost</refentrytitle>
<refmiscinfo>blog</refmiscinfo>
</refmeta>
<refnamediv>
<refname>metaWeblog.editPost</refname>
<refpurpose>Edits existing blog message on the server.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_metaWeblog.editPost">
<funcprototype id="fproto_metaWeblog.editPost">
<funcdef>string <function>metaWeblog.editPost</function></funcdef>
<paramdef>in <parameter>postid</parameter> string</paramdef>
<paramdef>in <parameter>username</parameter> string</paramdef>
<paramdef>in <parameter>password</parameter> string</paramdef>
<paramdef>in <parameter>content</parameter> struct</paramdef>
<paramdef>in <parameter>publish</parameter> boolean</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_metaWeblog.editPost">
<title>Description</title>
<para>This function updates an existing post and optionally publishes it.</para>
</refsect1>
<refsect1 id="params_metaWeblog.editPost"><title>Parameters</title>
<refsect2><title>postid</title>
<para>The identity of the post.</para></refsect2>
<refsect2><title>username</title>
<para>name of user to be authenticated.</para></refsect2>
<refsect2><title>password</title>
<para>password for username.</para></refsect2>
<refsect2><title>content</title>
<para>The content is a struct that can contain the following standard keys:</para>
<programlisting>
{
string title - for the title of the entry;
string description - for the body of the entry;
string dateCreated - to set the created-on date of the entry.
int mt_allow_comments - the value for the "allow_comments" field.
int mt_allow_pings - the value for the "allow_pings" field.
string mt_convert_breaks - the value for the "convert_breaks" field.
string mt_text_more - the value for the additional entry text.
string mt_excerpt - the value for the excerpt field;
string mt_keywords - the value for the keywords field;
array mt_tb_ping_urls - the list of TrackBack ping URLs for this entry.
}
</programlisting>
<para>dateCreated should be in ISO.8601 format if specified.</para>
</refsect2>
<refsect2><title>publish</title>
<para>Publish Flag.</para></refsect2>
</refsect1>
<refsect1 id="ret_metaWeblog.editPost"><title>Return Types</title>
<para>Upon success the true boolean value will be returned. Upon failure the fault will be returned.</para>
</refsect1>
<!--
<refsect1 id="errors_metaWeblog.editPost">
<title>Errors</title>
<para>This function can generate the following errors:</para>
<errorcode></errorcode>
</refsect1>
<refsect1 id="examples_metaWeblog.editPost">
<title>Examples</title>
<example id="ex_"><title />
<para />
<screen>
</screen>
</example>
</refsect1>
-->
<refsect1 id="seealso_metaWeblog.editPost">
<title>See Also</title>
<para><link linkend="fn_metaWeblog.newPost"><function>metaWeblog.newPost()</function></link></para>
<para><link linkend="fn_metaWeblog.editPost"><function>metaWeblog.editPost()</function></link></para>
<para><link linkend="fn_metaWeblog.getPost"><function>metaWeblog.getPost()</function></link></para>
<para><link linkend="fn_metaWeblog.getRecentPosts"><function>metaWeblog.getRecentPosts()</function></link></para>
</refsect1>
</refentry>
|