Ryujinx-GtkSharp/doc/en/Gda/Parameter.xml
Fawad Halim 9e9ba80d18 GDA documentation contributed by Nestor Salceda <wizito@gentelibre.org>
svn path=/trunk/gtk-sharp/; revision=33581
2004-09-08 14:56:46 +00:00

192 lines
6.6 KiB
XML

<Type Name="Parameter" FullName="Gda.Parameter">
<TypeSignature Language="C#" Value="public sealed struct Parameter" 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>
Management of parameters. Parameters are the way clients have to send an unlimited number of arguments to the providers.
</para>
</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>
Gets the name of the Gda.Parameter.
</para>
<para>
Sets the name of the Gda.Parameter.
</para>
</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Value">
<MemberSignature Language="C#" Value="public Gda.Value Value { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gda.Value</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>
Gets the value in the Gda.Parameter.
</para>
<para>
Stores the given value in the Gda.Parameter.
</para>
</summary>
<returns>a <see cref="T:Gda.Value" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Parameter (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.Parameter" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Parameter (string name, bool value);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>
<para>
Creates a new Gda.Parameter froma a <see cref="T:System.Boolean" /> value.
</para>
</summary>
<param name="name">a <see cref="T:System.String" /></param>
<param name="value">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:Gda.Parameter" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Parameter (string name, double value);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>
<para>
Creates a new Gda.Parameter from a <see cref="T:System.Double" /> value.
</para>
</summary>
<param name="name">a <see cref="T:System.String" /></param>
<param name="value">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:Gda.Parameter" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Parameter (string name, Gda.Value value);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="value" Type="Gda.Value" />
</Parameters>
<Docs>
<summary>
<para>
Creates a new Gda.Parameter object, which is usually used with <see cref="T:Gda.ParameterList" />.
</para>
</summary>
<param name="name">a <see cref="T:System.String" /> which is the name for the parameter being created.</param>
<param name="value">a <see cref="T:Gda.Value" /></param>
<returns>a <see cref="T:Gda.Parameter" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Parameter (string name, GLib.Object value);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="value" Type="GLib.Object" />
</Parameters>
<Docs>
<summary>
<para>
Creates a new Gda.Parameter from a <see cref="T:GLib.Object" /></para>
</summary>
<param name="name">a <see cref="T:System.String" /></param>
<param name="value">a <see cref="T:GLib.Object" /></param>
<returns>a <see cref="T:Gda.Parameter" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Parameter (string name, string value);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para>
Creates a new Gda.Parameter from a <see cref="T:System.String" />.
</para>
</summary>
<param name="name">a <see cref="T:System.String" /></param>
<param name="value">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gda.Parameter" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>