<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.20 $ -->
 <reference id="ref.mcal">
  <title>MCAL 関数</title>
  <titleabbrev>MCAL</titleabbrev>

  <partintro>
   <para>
    MCAL は、Modular Calendar Access Library を意味します。
   </para>
   <para>
    libmcal は、カレンダーアクセス用の C ライブラリです。このライブラ
    リは、結合性の高いドライバとして書かれています。MCAL は、メールボッ
    クス用の IMAP モジュールのカレンダー版です。
   </para>
   <para>
    mcal サポート機能により、カレンダーストリームを IMAP サポート機能
    によるメールボックスストリームと全く同様にオープンすることができま
    す。カレンダーは、ローカルファイルに保存したり、リモートのICAPサー
    バーとしたり、mcal ライブラリによりサポートされる他のフォーマット
    とすることができます。
   </para>
   <para>
    カレンダーイベントは、発生、検索、保存することができます。カレンダー
    のトリガー(アラーム)および定期的なイベントもサポートされます。
   </para>
   <para>
    libmcal により、メインのカレンダーサーバーをアクセス、使用することが
    できます。この場合、特定のデータベースおよびローカルファイルに依存した
    プログラミングは必要ありません。
   </para>
   <para>
   これらの関数を動作させるには、PHP を
    <option role="configure">--with-mcal</option> を付けてコンパイルする
    必要があります。この場合、mcal ライブラリがインストールされている
    必要があります。最新版を <ulink
    url="&url.mcal;">&url.mcal;</ulink> 
    から取得し、コンパイル、インストールしてください。
   </para>
   <para>
    MCALモジュールを使用する場合に次の定数が定義されます。
    曜日用 :
     <itemizedlist>
      <listitem><simpara>
        MCAL_SUNDAY
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_MONDAY
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_TUESDAY
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_WEDNESDAY
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_THURSDAY
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_FRIDAY
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_SATURDAY
      </simpara></listitem>
     </itemizedlist>
    反復用 :
     <itemizedlist>
      <listitem><simpara>
	    MCAL_RECUR_NONE
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_RECUR_DAILY
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_RECUR_WEEKLY
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_RECUR_MONTHLY_MDAY
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_RECUR_MONTHLY_WDAY
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_RECUR_YEARLY
      </simpara></listitem>
     </itemizedlist>
    月用 :
     <itemizedlist>
      <listitem><simpara>
	    MCAL_JANUARY
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_FEBRUARY
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_MARCH
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_APRIL
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_MAY
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_JUNE
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_JULY
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_AUGUST
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_SEPTEMBER
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_OCTOBER
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_NOVEMBER
      </simpara></listitem>
      <listitem><simpara>
	    MCAL_DECEMBER
      </simpara></listitem>
     </itemizedlist>
    多くの関数は、各ストリーム毎に固有の内部イベント構造体を使用します。
    これにより、大きなオブジェクトを関数の間で渡すことが容易になります。
    イベント構造体の値を設定、初期化、取得する便利な関数があります。
   </para>
  </partintro>

  <refentry id="function.mcal-open">
   <refnamediv>
    <refname>mcal_open</refname>
    <refpurpose>MCAL 接続をオープンする</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_open</methodname>
      <methodparam><type>string</type><parameter>calendar</parameter></methodparam>
      <methodparam><type>string</type><parameter>username</parameter></methodparam>
      <methodparam><type>string</type><parameter>password</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
     </methodsynopsis>
    <para>
     成功時に MCAL ストリーム、エラー時に &false; を返します。
    </para>
    <para>
     <function>mcal_open</function> は、指定した
     <parameter>calendar</parameter> 保存ファイルへの MCAL 接続を
     オープンします。
     オプション <parameter>options</parameter> が指定された場合、
     <parameter>options</parameter> もメールボックスに渡されます。
     ストリームの内部イベント構造体も接続時に初期化されます。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-popen">
   <refnamediv>
    <refname>mcal_popen</refname>
    <refpurpose>永続的なMCAL接続をオープンする</refpurpose>
   </refnamediv>
   <refsect1>
    <title>接続</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_popen</methodname>
      <methodparam><type>string</type><parameter>calendar</parameter></methodparam>
      <methodparam><type>string</type><parameter>username</parameter></methodparam>
      <methodparam><type>string</type><parameter>password</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
     </methodsynopsis>
    <para>
     成功時にMCALストリームを返し、エラー時に flase を返します。
    </para>  
    <para>
     <function>mcal_popen</function> は、指定した
     <parameter>calendar</parameter> が保存しているMCAL接続をオープン
     します。オプションの<parameter>options</parameter>が指定された場
     合、<parameter>options</parameter> をメールボックスにも渡します。
     内部イベント構造体のストリームも接続時に初期化されます。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-reopen">
   <refnamediv>
    <refname>mcal_reopen</refname>
    <refpurpose>MCAL接続を再オープンする</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_reopen</methodname>
      <methodparam><type>string</type><parameter>calendar</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
     </methodsynopsis>
    <para>
     MCALストリームを新規カレンダー用に再オープンします。
    </para>  
    <para>
     <function>mcal_reopen</function>は、指定した
     <parameter>calendar</parameter>が保存したMCAL接続を再オープンしま
     す。オプションの <parameter>options</parameter> が指定された場合、
     <parameter>options</parameter> をメールボックスにも渡します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-close">
   <refnamediv>
    <refname>mcal_close</refname>
    <refpurpose>MCAL ストリームを閉じる</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_close</methodname>
      <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para> 
     指定した mcal ストリームを閉じます。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-create-calendar">
   <refnamediv>
    <refname>mcal_create_calendar</refname>
    <refpurpose>新規にMCALカレンダを作成する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>string</type><methodname>mcal_create_calendar</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>calendar</parameter></methodparam>
     </methodsynopsis>
    <para> 
     <parameter>calendar</parameter> という名前で新規のカレンダを作成
     します。
    </para> 
   </refsect1>
  </refentry>
  
  <refentry id="function.mcal-rename-calendar">
   <refnamediv>
    <refname>mcal_rename_calendar</refname>
    <refpurpose>MCALカレンダの名前を変更する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>string</type><methodname>mcal_rename_calendar</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>old_name</parameter></methodparam>
      <methodparam><type>string</type><parameter>new_name</parameter></methodparam>
     </methodsynopsis>
    <para> 
     カレンダ名 <parameter>old_name</parameter> を
     <parameter>new_name</parameter> に変更します。
    </para> 
   </refsect1>
  </refentry>
  
  <refentry id="function.mcal-delete-calendar">
   <refnamediv>
    <refname>mcal_delete_calendar</refname>
    <refpurpose>MCALカレンダを削除する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>string</type><methodname>mcal_delete_calendar</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>calendar</parameter></methodparam>
     </methodsynopsis>
    <para> 
     <parameter>calendar</parameter>という名前のカレンダを削除します。
    </para> 
   </refsect1>
  </refentry>

  <refentry id="function.mcal-fetch-event">
   <refnamediv>
    <refname>mcal_fetch_event</refname>
    <refpurpose>
     カレンダーストリームからイベントを取得する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>object</type><methodname>mcal_fetch_event</methodname>
      <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>event_id</parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>options</optional></replaceable>
       </parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_fetch_event</function> は、
     <parameter>id</parameter> で指定されたカレンダーストリームから
     イベントを取得します。
    </para>
    <para>
     以下の要素からなるイベントオブジェクトを返します。
     <itemizedlist>
      <listitem>
       <simpara>
	int id - イベント ID
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int public - イベントが public な場合は &true;、private な場合は
	&false;
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	string category - イベントのカテゴリを表す文字列
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	string title - イベントのタイトルを表す文字列
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	string description - イベントの内容を表す文字列
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int alarm - アラーム・リマインダイベントが送られるまでの分単位
	の時間
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	object start - datetime エントリを有するオブジェクト
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	object end - datetime エントリを有するオブジェクト
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int id - イベント ID 
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int public - イベントが public な場合は &true;、private な場合は
	&false;
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	string category - イベントのカテゴリを表す文字列
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	string title - イベントのタイトルを表す文字列
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	string description - イベントの内容を表す文字列
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int alarm - アラーム・リマインダイベントが送られるまでの分単位
	の時間
       </simpara>
      </listitem>
      <listitem><simpara>
	object start - datetime エントリを有するオブジェクト
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	object end - datetime エントリを有するオブジェクト
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int recur_type   - 繰り返しの型
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int recur_interval   - 繰り返し周期
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	datetime recur_enddate   - 繰り返しが終わる日
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int recur_data   - 繰り返しデータ
       </simpara>
      </listitem>
     </itemizedlist>
     全ての datetime エントリは、次の要素を有するオブジェクトから
     構成されます。
     <itemizedlist>
      <listitem>
       <simpara>
	int year - 年
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int month - 月
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int mday  - 日
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int hour  - 時間
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int min   - 分
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int sec   - 秒
       </simpara>
      </listitem>         
      <listitem>
       <simpara>
	int alarm   - アラームを送るイベントまでの分単位の時間
       </simpara>
      </listitem>
     </itemizedlist>

     recur_type で使用可能な値を以下に示します。

     <itemizedlist>
      <listitem>
       <simpara>
	0 - このイベントが繰り返さないことを示す
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	1 - このイベントが一日毎に繰り返す
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	2 - このイベントが1週間毎に繰り返す
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	3 - このイベントは指定した日に毎月発生する (例 毎月十日)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	4 - このイベントは月単位の週の曜日に発生する (例 第３土曜日)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	5 - このイベントは年単位で発生する
       </simpara>
      </listitem>         
     </itemizedlist>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-list-events">
   <refnamediv>
    <refname>mcal_list_events</refname>
    <refpurpose>
     日付または日付の範囲に関してIDのリストを返す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>array</type><methodname>mcal_list_events</methodname>
      <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
      <methodparam><type>object</type><parameter>begin_date</parameter></methodparam>
      <methodparam><type>object</type><parameter>
	<replaceable><optional>end_date</optional></replaceable>
       </parameter></methodparam>
     </methodsynopsis>
    <para>
     開始日および終了日の間のイベントのIDの配列を返します。ストリーム
     だけを指定した場合、グローバルイベント構造体の開始日および終了日
     を使用します。
    </para>
    <para> 
     <function>mcal_list_events</function> 関数は、カレンダーストリー
     ムの開始日およびオプションで終了日をとります。指定した日または内
     部イベントの間にあるイベントのIDの配列が返されます。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-append-event">
   <refnamediv>
    <refname>mcal_append_event</refname>
    <refpurpose>MCALカレンダーに新規イベントを保存する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_append_event</methodname>
      <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
     </methodsynopsis>
    <para> 
     <function>mcal_append_event</function>はグローバルイベントを
     指定したストリームのMCALカレンダーに保存します。
    </para>
    <para>
     新規に挿入されたイベントのuidを返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-store-event">
   <refnamediv>
    <refname>mcal_store_event</refname>
    <refpurpose>MCALカレンダーの既存のイベントを修正する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_store_event</methodname>
      <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
     </methodsynopsis>
    <para> 
     <function>mcal_store_event</function> は、修正したイベント
     を指定したストリームの現在のグローバルイベントに保存します。
    </para>
    <para>
     成功時に修正したイベントのイベントID、エラー時に &false; を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-delete-event">
   <refnamediv>
    <refname>mcal_delete_event</refname>
    <refpurpose>MCAL カレンダーからイベントを削除する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_delete_event</methodname>
      <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>event_id</optional></replaceable>
       </parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_delete_event</function> は event_idで指定したカレ
     ンダーイベントを削除します。
    </para>
    <para>
     &true;を返します。
   </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-snooze">
   <refnamediv>
    <refname>mcal_snooze</refname>
    <refpurpose>イベントのアラームをオフにする</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_snooze</methodname>
      <methodparam><type>int</type><parameter>id</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_snooze</function> は id で指定したカレンダーイベ
     ントのアラームをオフにします。
    </para>
    <para>
     &true;を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-list-alarms">
   <refnamediv>
    <refname>mcal_list_alarms</refname>
    <refpurpose>
    指定した datetime までにアラームを発生するイベントのリストを返す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>array</type><methodname>mcal_list_alarms</methodname>
      <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>begin_year</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>begin_month</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>begin_day</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>end_year</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>end_month</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>end_day</optional></replaceable>
       </parameter></methodparam>
     </methodsynopsis>
    <para>
     開始日から終了日までの間にアラームがオフとなるイベントのIDの配列が
     返されます。ストリームだけが指定された場合、グローバルイベント構造
     体の開始日および終了日を使用します。
    </para>
    <para> 
     <function>mcal_list_events</function> オプションでカレンダースト
     リームの開始日と終了日をとります。指定した日または内部イベントの
     間にあるイベントのIDの配列が返されます。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-init">
   <refnamediv>
    <refname>mcal_event_init</refname>
    <refpurpose>
    グローバルイベント構造体のストリームを初期化する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_event_init</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_init</function> は、グローバルイベント構造体
     ストリームを初期化します。これにより、構造体の全ての要素に効率的
     に0またはデフォルト値が設定されます。
    </para>
    <para>
     &true; を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-set-category">
   <refnamediv>
    <refname>mcal_event_set_category</refname>
    <refpurpose>
     グローバルイベント構造体ストリームの«テゴリを設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_event_set_category</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>category</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_set_category</function> は、グローバルイベン
     ト構造体のcategoryを指定した文字列に設定します。
    </para>
    <para>
     &true; を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-set-title">
   <refnamediv>
    <refname>mcal_event_set_title</refname>
    <refpurpose>
    グローバルイベント構造体ストリームのtitleを設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_event_set_title</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>title</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_set_title</function>は、グローバルイベント構
     造体ストリームのtitleを指定した文字列に設定します。
    </para>
    <para>
     &true;を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-set-description">
   <refnamediv>
    <refname>mcal_event_set_description</refname>
    <refpurpose>
    グローバルイベント構造体ストリームの description を設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_event_set_description</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>description</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_set_description</function> は、グローバルイ
     ベント構造体ストリームのdescriptionを指定した文字列に設定します。
    </para>
    <para>
     &true; を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-set-start">
   <refnamediv>
    <refname>mcal_event_set_start</refname>
    <refpurpose>
     グローバルイベント構造体ストリームの開始日を設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_event_set_start</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>year</parameter></methodparam>
      <methodparam><type>int</type><parameter>month</parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>day</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>hour</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>min</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>sec</optional></replaceable>
       </parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_set_start</function> は、グローバルイベント
     構造体ストリームの開始日を指定した値に設定します。
    </para>
    <para>
     &true; を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-set-end">
   <refnamediv>
    <refname>mcal_event_set_end</refname>
    <refpurpose>
     グローバルイベント構造体ストリームの終了日を設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_event_set_end</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>year</parameter></methodparam>
      <methodparam><type>int</type><parameter>month</parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>day</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>hour</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>min</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>sec</optional></replaceable>
       </parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_set_end</function> は、グローバルイベント構
     造体ストリームの終了日を指定した値に設定します。
    </para>
    <para>
     &true; を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-set-alarm">
   <refnamediv>
    <refname>mcal_event_set_alarm</refname>
    <refpurpose>
    グローバルイベント構造体ストリームのアラームを設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_event_set_alarm</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>alarm</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_set_alarm</function> は、グローバルイベント構造体
     ストリームのアラームをイベントの分単位の指定時間前に設定します。</para>
    <para>
     &true; を返します。</para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-set-class">
   <refnamediv>
    <refname>mcal_event_set_class</refname>
    <refpurpose>
     グローバルイベント構造体ストリームのクラスを設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_event_set_class</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>class</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_set_class</function> は、グローバルイベント
     構造体ストリームのクラスを指定した値に設定します。class は、
     public の場合 1、private の場合 0 とします。
    </para>
    <para>
     &true; を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-is-leap-year">
   <refnamediv>
    <refname>mcal_is_leap_year</refname>
    <refpurpose>
     指定した年が閏年であるかどうかを返す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_is_leap_year</methodname>
      <methodparam><type>int</type><parameter>year</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_is_leap_year</function> は指定した年が
     閏年である場合に 1、そうでない場合に 0 を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-days-in-month">
   <refnamediv>
    <refname>mcal_days_in_month</refname>
    <refpurpose>
    指定した月の日数を返す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_days_in_month</methodname>
      <methodparam><type>int</type><parameter>month</parameter></methodparam>
      <methodparam><type>int</type><parameter>year</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_days_in_month</function> は、
    指定した年が閏年であるかどうかを考慮しつつ、
    指定した月の日数を返します。</para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-date-valid">
   <refnamediv>
    <refname>mcal_date_valid</refname>
    <refpurpose>
    指定した年月日が有効な日付である場合に &true; を返す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_date_valid</methodname>
      <methodparam><type>int</type><parameter>year</parameter></methodparam>
      <methodparam><type>int</type><parameter>month</parameter></methodparam>
      <methodparam><type>int</type><parameter>day</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_date_valid</function>は、指定した年月日が有効な日
     付である場合に &true; を、そうでない場合に &false; を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-time-valid">
   <refnamediv>
    <refname>mcal_time_valid</refname>
    <refpurpose>
     指定した時間、分、秒が有効な時間である場合に &true; を返す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_time_valid</methodname>
      <methodparam><type>int</type><parameter>hour</parameter></methodparam>
      <methodparam><type>int</type><parameter>minutes</parameter></methodparam>
      <methodparam><type>int</type><parameter>seconds</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_time_valid</function>は、指定した時間、分、秒が有
     効な時間である場合に &true;を、そうでない場合に &false; を返しま
     す。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-day-of-week">
   <refnamediv>
    <refname>mcal_day_of_week</refname>
    <refpurpose>
    指定した日の曜日を返す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_day_of_week</methodname>
      <methodparam><type>int</type><parameter>year</parameter></methodparam>
      <methodparam><type>int</type><parameter>month</parameter></methodparam>
      <methodparam><type>int</type><parameter>day</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_day_of_week</function> は、指定した日の曜日を返し
     ます。返される値の範囲は、日曜日を意味する0から土曜日を意味する6
     までです。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-day-of-year">
   <refnamediv>
    <refname>mcal_day_of_year</refname>
    <refpurpose>
    指定した日の年間積算日を返す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_</methodname>
      <methodparam><type>int</type><parameter>year</parameter></methodparam>
      <methodparam><type>int</type><parameter>month</parameter></methodparam>
      <methodparam><type>int</type><parameter>day</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_day_of_year</function> は、
    指定した日の年間積算日を返します。</para>
    <para>
     &true; を返します。</para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-date-compare">
   <refnamediv>
    <refname>mcal_date_compare</refname>
    <refpurpose>二つの日付を比較する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_date_compare</methodname>
      <methodparam><type>int</type><parameter>a_year</parameter></methodparam>
      <methodparam><type>int</type><parameter>a_month</parameter></methodparam>
      <methodparam><type>int</type><parameter>a_day</parameter></methodparam>
      <methodparam><type>int</type><parameter>b_year</parameter></methodparam>
      <methodparam><type>int</type><parameter>b_month</parameter></methodparam>
      <methodparam><type>int</type><parameter>b_day</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_date_compare</function> は、二つの日付を比較し、
     a&lt;b , a==b, a>b の場合に、それぞれ、&lt;0, 0, >0  を返します。</para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-next-recurrence">
   <refnamediv>
    <refname>mcal_next_recurrence</refname>
    <refpurpose>イベントが次に発生する日を返す</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_next_recurrence</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>weekstart</parameter></methodparam>
      <methodparam><type>array</type><parameter>next</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_next_recurrence</function> は、指定した日以降に
     次のイベントが発生する日を有するオブジェクトを返します。
     イベントが発生しないか、何か問題がある場合は空の date フィールドを
     返します。weekstart により週の初めとなる曜日を指定することができます。</para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-set-recur-none">
   <refnamediv>
    <refname>mcal_event_set_recur_none</refname>
    <refpurpose>
    グローバルイベント構造体ストリームの反復を設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_event_set_recur_none</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_set_recur_none</function>は、
     グローバルイベント構造体ストリームの反復が行われないことを
     指定します。(event->recur_typeはMCAL_RECUR_NONEに設定されます。)</para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-set-recur-daily">
   <refnamediv>
    <refname>mcal_event_set_recur_daily</refname>
    <refpurpose>
     グローバルイベント構造体ストリームの反復を設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_event_set_recur_daily</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>year</parameter></methodparam>
      <methodparam><type>int</type><parameter>month</parameter></methodparam>
      <methodparam><type>int</type><parameter>day</parameter></methodparam>
      <methodparam><type>int</type><parameter>interval</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_set_recur_daily</function> は、
     グローバルイベント構造体ストリームが次に発生する日を
     指定した値に設定します。イベントが、
     指定した日まで毎日発生するものとして設定します。</para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-set-recur-weekly">
   <refnamediv>
    <refname>mcal_event_set_recur_weekly</refname>
    <refpurpose>
     グローバルイベント構造体ストリームの繰り返しを設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_event_set_recur_weekly</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>year</parameter></methodparam>
      <methodparam><type>int</type><parameter>month</parameter></methodparam>
      <methodparam><type>int</type><parameter>day</parameter></methodparam>
      <methodparam><type>int</type><parameter>interval</parameter></methodparam>
      <methodparam><type>int</type><parameter>weekdays</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_set_recur_weekly</function> は、
     グローバルイベント構造体ストリームが次に発生する日を
     指定した値に設定します。イベントが、
     指定した日まで毎週指定曜日に発生するものとして設定します。</para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-set-recur-monthly-mday">
   <refnamediv>
    <refname>mcal_event_set_recur_monthly_mday</refname>
    <refpurpose>
     グローバルイベント構造体ストリームの繰り返しを設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_event_set_recur_monthly_mday</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>year</parameter></methodparam>
      <methodparam><type>int</type><parameter>month</parameter></methodparam>
      <methodparam><type>int</type><parameter>day</parameter></methodparam>
      <methodparam><type>int</type><parameter>interval</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_set_recur_monthly_mday</function> は、
     グローバルイベント構造体ストリームが次に発生する日を
     指定した値に設定します。イベントが、
     指定した日まで毎月指定日に発生するものとして設定します。</para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-set-recur-monthly-wday">
   <refnamediv>
    <refname>mcal_event_set_recur_monthly_wday</refname>
    <refpurpose>
     グローバルイベント構造体ストリームの繰り返しを設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_event_set_recur_monthly_wday</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>year</parameter></methodparam>
      <methodparam><type>int</type><parameter>month</parameter></methodparam>
      <methodparam><type>int</type><parameter>day</parameter></methodparam>
      <methodparam><type>int</type><parameter>interval</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_set_recur_monthly_wday</function> は、
     グローバルイベント構造体ストリームが次に発生する日を
     指定した値に設定します。イベントが、
     指定した日まで毎月指定曜日に発生するものとして設定します。</para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-set-recur-yearly">
   <refnamediv>
    <refname>mcal_event_set_recur_yearly</refname>
    <refpurpose>
     グローバルイベント構造体ストリームの繰り返しを設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_event_set_recur_yearly</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>year</parameter></methodparam>
      <methodparam><type>int</type><parameter>month</parameter></methodparam>
      <methodparam><type>int</type><parameter>day</parameter></methodparam>
      <methodparam><type>int</type><parameter>interval</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_set_recur_yearly</function> は、
     グローバルイベント構造体ストリームが次に発生する日を
     指定した値に設定します。イベントが、
     指定した日まで毎年指定日に発生するものとして設定します。</para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-fetch-current-stream-event">
   <refnamediv>
    <refname>mcal_fetch_current_stream_event</refname>
    <refpurpose>
    現在のイベント構造体ストリームを有するオブジェクトを返す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>object</type><methodname>mcal_fetch_current_stream_event</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_fetch_current_stream_event</function>
     は、次の要素を有する現在のイベント構造ストリームを有する
     オブジェクトを返します。
     
     <itemizedlist>
      <listitem>
       <simpara>
	int id
	- イベントID
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int public
	- イベントが public の場合に &true;、private の場合に &false;。
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	string category
	- イベントの Category 文字列。
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	string title 
	- イベントの Title 文字列。
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	string description
	- イベントの Description 文字列。
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int alarm
	- アラーム・リマインダを送るイベントまでの分単位の時間。
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	object start 
	- 開始 datetime エントリを有するオブジェクト。
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	object end
	- 終了 datetime エントリを有するオブジェクト。
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int recur_type 
	- 繰り返し型
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int recur_interval
	- 繰り返し間隔
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	datetime recur_enddate   
	- 繰り返し終了日
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int recur_data   
	- 繰り返しデータ
       </simpara>
      </listitem>
     </itemizedlist>

     全ての datetime エントリは、次の要素を有するオブジェクトから
     構成されます。

     <itemizedlist>
      <listitem>
       <simpara>
	int year - 年
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int month - 月
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int mday  - 日
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int hour  - 時
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int min   - 分
       </simpara>
      </listitem>
      <listitem>
       <simpara>
	int sec   - 秒
       </simpara>
      </listitem>         
      <listitem>
       <simpara>
	int alarm   - イベントを送信するまでの分単位の時間
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-event-add-attribute">
   <refnamediv>
    <refname>mcal_event_add_attribute</refname>
    <refpurpose>
     グローバルイベント構造体ストリームに属性およびその値を追加する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>void</type><methodname>mcal_event_add_attribute</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>attribute</parameter></methodparam>
      <methodparam><type>string</type><parameter>value</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_event_add_attribute</function> は、"value"で値を指
     定したグローバルイベント構造体のストリームに属性を追加します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.mcal-expunge">
   <refnamediv>
    <refname>mcal_expunge</refname>
    <refpurpose>
     削除マークを付けられた全てのイベントを削除する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_expunge</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
     </methodsynopsis>
    <para>  
     <function>mcal_expunge</function> は、過去に削除マークを付けられ
     た全てのイベントを削除します。
    </para>
   </refsect1>
  </refentry>

  <refentry id='function.mcal-week-of-year'>
   <refnamediv>
    <refname>mcal_week_of_year</refname>
    <refpurpose>
     指定した日付の週番号を返す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>mcal_week_of_year</methodname>
      <methodparam><type>int</type><parameter>day</parameter></methodparam>
      <methodparam><type>int</type><parameter>month</parameter></methodparam>
      <methodparam><type>int</type><parameter>year</parameter></methodparam>
     </methodsynopsis>
    <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:
-->