File: ArgIterator.xml

package info (click to toggle)
monodoc 1.1.18-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 58,432 kB
  • ctags: 4,991
  • sloc: xml: 718,392; cs: 38,337; sh: 3,172; perl: 554; makefile: 303
file content (181 lines) | stat: -rwxr-xr-x 6,796 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<Type Name="ArgIterator" FullName="System.ArgIterator">
  <TypeSignature Maintainer="auto" Language="C#" Value="public struct ArgIterator" />
  <AssemblyInfo>
    <AssemblyName>mscorlib</AssemblyName>
    <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  </AssemblyInfo>
  <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  <Docs>
    <summary>This class is used to acess variable arguments on methods that use the __arglist calling convention.</summary>
    <remarks>To be added</remarks>
  </Docs>
  <Base>
    <BaseTypeName>System.ValueType</BaseTypeName>
  </Base>
  <Interfaces />
  <Members>
    <Member MemberName="GetNextArg">
      <MemberSignature Language="C#" Value="public TypedReference GetNextArg ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.TypedReference</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the next argument.</summary>
        <returns>Returns the next argument as a <see cref="T:System.TypedReference" />.</returns>
        <remarks>This advances the position of the argument iterator.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetNextArg">
      <MemberSignature Language="C#" Value="public TypedReference GetNextArg (RuntimeTypeHandle rth);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.TypedReference</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="rth" Type="System.RuntimeTypeHandle" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="rth">To be added: an object of type 'RuntimeTypeHandle'</param>
        <returns>To be added: an object of type 'TypedReference'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="End">
      <MemberSignature Language="C#" Value="public void End ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Finishes iterating over the arguments.</summary>
        <remarks>Invalidates the ArgIterator instance, from this point on operations will throw an exception.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetRemainingCount">
      <MemberSignature Language="C#" Value="public int GetRemainingCount ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the number of remaining arguments to be processed.</summary>
        <returns>The count of arguments remaining to be processed.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="GetNextArgType">
      <MemberSignature Language="C#" Value="public RuntimeTypeHandle GetNextArgType ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.RuntimeTypeHandle</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the type of the next argument.</summary>
        <returns>To be added: an object of type 'RuntimeTypeHandle'</returns>
        <remarks>This does not advance the current position in the iterator.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ArgIterator (RuntimeArgumentHandle arglist);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="arglist" Type="System.RuntimeArgumentHandle" />
      </Parameters>
      <Docs>
        <summary>Creates an ArgIterator from a RuntimeArgumentHandle.</summary>
        <param name="arglist">The handle to the argument list, as obtained by the special compiler __arglist expression.</param>
        <remarks>Here is an example of a routine that uses the __arglist calling conventions:


<example>
            <code lang="C#">
using System;

class ArgIteratorDemo {

        static int AddABunchOfInts (__arglist)
        {
                int result = 0;

                System.ArgIterator iter = new System.ArgIterator (__arglist);
                int argCount = iter.GetRemainingCount();

                for (int i = 0; i &lt; argCount; i++) {
                        System.TypedReference typedRef = iter.GetNextArg();
                        result += (int)TypedReference.ToObject( typedRef );
                }

                return result;
        }

        static void Main (string[] args)
        {
                int result = AddABunchOfInts (__arglist ( 2, 3, 4 ));
                Console.WriteLine ("Answer: {0}", result);
	}
}
  </code>
          </example></remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ArgIterator (RuntimeArgumentHandle arglist, void* ptr);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="arglist" Type="System.RuntimeArgumentHandle" />
        <Parameter Name="ptr" Type="System.Void*" />
      </Parameters>
      <Docs>
        <summary>Initialize an ArgIterator using a base address.</summary>
        <param name="arglist">The argument list, as obtained by the special compiler keyword __arglist.</param>
        <param name="ptr">Overrides the starting address for computing parameters.</param>
        <remarks>Here is an example of a routine that uses the __arglist calling conventions:


<example>
            <code lang="C#">
using System;

class ArgIteratorDemo {

        static int AddABunchOfInts (__arglist)
        {
                int result = 0;

                System.ArgIterator iter = new System.ArgIterator (__arglist);
                int argCount = iter.GetRemainingCount();

                for (int i = 0; i &lt; argCount; i++) {
                        System.TypedReference typedRef = iter.GetNextArg();
                        result += (int)TypedReference.ToObject( typedRef );
                }

                return result;
        }

        static void Main (string[] args)
        {
                int result = AddABunchOfInts (__arglist ( 2, 3, 4 ));
                Console.WriteLine ("Answer: {0}", result);
	}
}
  </code>
          </example></remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>System.CLSCompliant(false)</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
  </Members>
</Type>