← Back to branch summary

~ubuntu-branches/ubuntu/trusty/libprelude/trusty

« back to all changes in this revision

Viewing changes to docs/api/xml/idmef-path.xml

  • Committer: Bazaar Package Importer
  • Author(s): Alessio Treglia
  • Date: 2009-06-10 08:50:59 UTC
  • mfrom: (1.1.13 upstream) (2.1.5 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090610085059-iflguu0i75ce5q4f
Tags: 0.9.23-1ubuntu1
* Merge from debian unstable, Ubuntu remaining changes:
  - Build-Depends on libltdl7-dev instead of libltdl3-dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/api/xml/idmef-path.xml
65
65
<link linkend="prelude-bool-t">prelude_bool_t</link>      <link linkend="idmef-path-is-list">idmef_path_is_list</link>                  (const <link linkend="idmef-path-t">idmef_path_t</link> *path,
66
66
                                                         <link linkend="int">int</link> depth);
67
67
unsigned <link linkend="int">int</link>        <link linkend="idmef-path-get-depth">idmef_path_get_depth</link>                (const <link linkend="idmef-path-t">idmef_path_t</link> *path);
 
68
<link linkend="int">int</link>                 <link linkend="idmef-path-check-operator">idmef_path_check_operator</link>           (const <link linkend="idmef-path-t">idmef_path_t</link> *path,
 
69
                                                         <link linkend="idmef-criterion-operator-t">idmef_criterion_operator_t</link> op);
 
70
<link linkend="int">int</link>                 <link linkend="idmef-path-get-applicable-operators">idmef_path_get_applicable_operators</link> (const <link linkend="idmef-path-t">idmef_path_t</link> *path,
 
71
                                                         <link linkend="idmef-criterion-operator-t">idmef_criterion_operator_t</link> *result);
68
72
</synopsis>
69
73
</refsynopsisdiv>
70
74
 
618
622
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <parameter>depth</parameter> number of elements.
619
623
</simpara></listitem></varlistentry>
620
624
</variablelist></refsect2>
 
625
<refsect2 id="idmef-path-check-operator" role="function">
 
626
<title>idmef_path_check_operator ()</title>
 
627
<indexterm zone="idmef-path-check-operator"><primary>idmef_path_check_operator</primary></indexterm><programlisting><link linkend="int">int</link>                 idmef_path_check_operator           (const <link linkend="idmef-path-t">idmef_path_t</link> *path,
 
628
                                                         <link linkend="idmef-criterion-operator-t">idmef_criterion_operator_t</link> op);</programlisting>
 
629
<para>
 
630
Check whether <parameter>operator</parameter> can apply to value pointed to by <parameter>path</parameter>.</para>
 
631
<para>
 
632
 
 
633
</para><variablelist role="params">
 
634
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
635
<listitem><simpara> Pointer to a <link linkend="idmef-path-t"><type>idmef_path_t</type></link> object.
 
636
</simpara></listitem></varlistentry>
 
637
<varlistentry><term><parameter>op</parameter>&nbsp;:</term>
 
638
<listitem><simpara>
 
639
</simpara></listitem></varlistentry>
 
640
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 0 on success, a negative value if an error occured.
 
641
</simpara></listitem></varlistentry>
 
642
</variablelist></refsect2>
 
643
<refsect2 id="idmef-path-get-applicable-operators" role="function">
 
644
<title>idmef_path_get_applicable_operators ()</title>
 
645
<indexterm zone="idmef-path-get-applicable-operators"><primary>idmef_path_get_applicable_operators</primary></indexterm><programlisting><link linkend="int">int</link>                 idmef_path_get_applicable_operators (const <link linkend="idmef-path-t">idmef_path_t</link> *path,
 
646
                                                         <link linkend="idmef-criterion-operator-t">idmef_criterion_operator_t</link> *result);</programlisting>
 
647
<para>
 
648
Retrieve all applicable operator that might be used by the type of
 
649
value pointed to by <parameter>path</parameter>.</para>
 
650
<para>
 
651
 
 
652
</para><variablelist role="params">
 
653
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
654
<listitem><simpara> Pointer to a <link linkend="idmef-path-t"><type>idmef_path_t</type></link> object.
 
655
</simpara></listitem></varlistentry>
 
656
<varlistentry><term><parameter>result</parameter>&nbsp;:</term>
 
657
<listitem><simpara> Pointer to storage for applicable operator.
 
658
</simpara></listitem></varlistentry>
 
659
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 0 on success, a negative value if an error occured.
 
660
</simpara></listitem></varlistentry>
 
661
</variablelist></refsect2>
621
662
 
622
663
</refsect1>
623
664