docs-xml/smbdotconf/misc/wspproperties.xml

   1 <samba:parameter name="wsp property file"
   2                  context="G"
   3                  type="string"
   4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   5 <description>
   6         <para>
   7         <smbconfoption name="wsp property file"/> parameter.
   8         This parameter specifies the file where additional WSP Windows Search Protocol properties
   9         are stored. The format of the file is a csv consisting of 10 comma separated columns. The
  10         first 3 columns are required, the other columns are desirable but not necessary.
  11         </para>
  12         <variablelist>
  13                 <varlistentry>
  14                         <term>Property Name</term>
  15                         <listitem><para>A property name e.g. System.ItemUrl.</para></listitem>
  16                 </varlistentry>
  17                 <varlistentry>
  18                         <term>GUID</term>
  19                         <listitem><para>A guid that identifies the propertyset the property belongs to.</para></listitem>
  20                 </varlistentry>
  21                 <varlistentry>
  22                         <term>prop ID</term>
  23                         <listitem><para>A number that together with the GUID uniquely identifies the property.</para></listitem>
  24                 </varlistentry>
  25                 <varlistentry>
  26                         <term>inInverted Index</term>
  27                         <listitem><para>Set to TRUE is the property is indexed.</para></listitem>
  28                 </varlistentry>
  29                 <varlistentry>
  30                         <term>isColumn</term>
  31                         <listitem><para>Set to TRUE if the property is one that can be returned in rows returned from WSP query.</para></listitem>
  32                 </varlistentry>
  33                 <varlistentry>
  34                         <term>type</term>
  35                         <listitem><para>One of
  36                         <emphasis>Boolean</emphasis>,<emphasis>Buffer</emphasis>,<emphasis>Byte</emphasis>,<emphasis>DateTime</emphasis>,<emphasis>Double</emphasis>,<emphasis>Int32</emphasis>,<emphasis>String</emphasis>,<emphasis>UInt16</emphasis>,<emphasis>UInt32</emphasis>,<emphasis>UInt64</emphasis> </para></listitem>
  37                 </varlistentry>
  38                 <varlistentry>
  39                         <term>MaxSize</term>
  40                         <listitem><para>maximum size when stored.</para></listitem>
  41                 </varlistentry>
  42                 <varlistentry>
  43                         <term>Vector Property</term>
  44                         <listitem><para>TRUE if this is a multivalue property.</para></listitem>
  45                 </varlistentry>
  46                 <varlistentry>
  47                         <term>Description</term>
  48                         <listitem><para>Description of what the property is used for.</para></listitem>
  49                 </varlistentry>
  50         </variablelist>
  51
  52
  53 </description>
  54 <value type="default"/>
  55 </samba:parameter>