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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<refentry id="function.mcal-list-events">
<refnamediv>
<refname>mcal_list_events</refname>
<refpurpose>
Return a list of IDs for a date or a range of dates
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>mcal_list_events</methodname>
<methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>begin_year</parameter></methodparam>
<methodparam><type>int</type><parameter>begin_month</parameter></methodparam>
<methodparam><type>int</type><parameter>begin_day</parameter></methodparam>
<methodparam><type>int</type><parameter>end_year</parameter></methodparam>
<methodparam><type>int</type><parameter>end_month</parameter></methodparam>
<methodparam><type>int</type><parameter>end_day</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of ID's that are between the start and end
dates, or if just a stream is given, uses the start and end dates
in the global event structure.
</para>
<para>
<function>mcal_list_events</function> takes in an
beginning date and an optional end date for a calendar stream. An
array of event id's that are between the given dates or the
internal event dates are returned.
</para>
</refsect1>
</refentry>
<!-- 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
-->
|
