GtkSharp/doc/en/Gda/Command.xml

<Type Name="Command" FullName="Gda.Command">
  <TypeSignature Language="C#" Value="public sealed struct Command" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>gda-sharp</AssemblyName>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
    <AssemblyCulture>neutral</AssemblyCulture>
    <Attributes />
  </AssemblyInfo>
  <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
  <Docs>
    <summary>
      <para>
 The Gda.Command structure holds data needed to issue a command to the providers. 
</para>
    </summary>
    <remarks>
      <para>
One interesting thing about Gda.Command's is that they can be reused over and over. That is, applications don't need to create a command every time they want to run something on the connected database. Moreover, the ability to create command strings with placeholders allows the use of parameters to specify the values for those placeholders.
</para>
    </remarks>
  </Docs>
  <Base>
    <BaseTypeName>GLib.Opaque</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes />
  <Members>
    <Member MemberName="Free">
      <MemberSignature Language="C#" Value="public void Free ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para>
Frees the resources allocated by Gda.Command's constructor.
</para>
        </summary>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="CommandType">
      <MemberSignature Language="C#" Value="public Gda.CommandType CommandType { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gda.CommandType</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para>
Gets the <see cref="T:Gda.CommandType" /> of command.
</para>
          <para>
Sets the <see cref="T:Gda.CommandType" /> of command.
</para>
        </summary>
        <returns>a <see cref="T:Gda.CommandType" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="Options">
      <MemberSignature Language="C#" Value="public Gda.CommandOptions Options { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gda.CommandOptions</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para>
Gets the  <see cref="T:Gda.CommandOptions" /> of cmd.
</para>
          <para>
Sets the <see cref="T:Gda.CommandOptions" /> of cmd.
</para>
        </summary>
        <returns>a <see cref="T:Gda.CommandOptions" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="Text">
      <MemberSignature Language="C#" Value="public string Text { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para>
Gets the command text.
</para>
          <para>
Sets the command text.
</para>
        </summary>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="Transaction">
      <MemberSignature Language="C#" Value="public Gda.Transaction Transaction { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gda.Transaction</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para>
Gets the <see cref="T:Gda.Transaction" /> associated with the Command.
</para>
          <para>
Sets the <see cref="T:Gda.Transaction" /> associated with the Command.
</para>
        </summary>
        <returns>a <see cref="T:Gda.Transaction" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Command (IntPtr raw);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="raw" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="raw">a <see cref="T:System.IntPtr" /></param>
        <returns>a <see cref="T:Gda.Command" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Command (string text, Gda.CommandType type, Gda.CommandOptions options);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="text" Type="System.String" />
        <Parameter Name="type" Type="Gda.CommandType" />
        <Parameter Name="options" Type="Gda.CommandOptions" />
      </Parameters>
      <Docs>
        <summary>
          <para>
Creates a new Gda.Command from the parameters.
</para>
        </summary>
        <param name="text">a <see cref="T:System.String" /></param>
        <param name="type">a <see cref="T:System.Int32" /></param>
        <param name="options">a <see cref="T:System.Int32" /></param>
        <returns>a <see cref="T:Gda.Command" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
  </Members>
</Type>