mscorlib(4.0.0.0) API with additions
System.ArgIterator Struct Reference

Represents a variable-length argument list; that is, the parameters of a function that takes a variable number of arguments. More...

Public Member Functions

 ArgIterator (RuntimeArgumentHandle arglist)
 Initializes a new instance of the T:System.ArgIterator structure using the specified argument list. More...
 
unsafe ArgIterator (RuntimeArgumentHandle arglist, void *ptr)
 Initializes a new instance of the T:System.ArgIterator structure using the specified argument list and a pointer to an item in the list. More...
 
unsafe TypedReference GetNextArg ()
 Returns the next argument in a variable-length argument list. More...
 
unsafe TypedReference GetNextArg (RuntimeTypeHandle rth)
 Returns the next argument in a variable-length argument list that has a specified type. More...
 
void End ()
 Concludes processing of the variable-length argument list represented by this instance. More...
 
int GetRemainingCount ()
 Returns the number of arguments remaining in the argument list. More...
 
unsafe RuntimeTypeHandle GetNextArgType ()
 Returns the type of the next argument. More...
 
override int GetHashCode ()
 Returns the hash code of this object. More...
 
override bool Equals (object o)
 This method is not supported, and always throws T:System.NotSupportedException. More...
 

Detailed Description

Represents a variable-length argument list; that is, the parameters of a function that takes a variable number of arguments.

Definition at line 7 of file ArgIterator.cs.

Constructor & Destructor Documentation

◆ ArgIterator() [1/2]

System.ArgIterator.ArgIterator ( RuntimeArgumentHandle  arglist)

Initializes a new instance of the T:System.ArgIterator structure using the specified argument list.

Parameters
arglistAn argument list consisting of mandatory and optional arguments.

Definition at line 26 of file ArgIterator.cs.

◆ ArgIterator() [2/2]

unsafe System.ArgIterator.ArgIterator ( RuntimeArgumentHandle  arglist,
void *  ptr 
)

Initializes a new instance of the T:System.ArgIterator structure using the specified argument list and a pointer to an item in the list.

Parameters
arglistAn argument list consisting of mandatory and optional arguments.
ptrA pointer to the argument in arglist to access first, or the first mandatory argument in arglist if ptr is null.

Definition at line 40 of file ArgIterator.cs.

Member Function Documentation

◆ End()

void System.ArgIterator.End ( )

Concludes processing of the variable-length argument list represented by this instance.

Definition at line 88 of file ArgIterator.cs.

◆ Equals()

override bool System.ArgIterator.Equals ( object  o)

This method is not supported, and always throws T:System.NotSupportedException.

Parameters
oAn object to be compared to this instance.
Returns
This comparison is not supported. No value is returned.
Exceptions
T:System.NotSupportedExceptionThis method is not supported.

Definition at line 121 of file ArgIterator.cs.

◆ GetHashCode()

override int System.ArgIterator.GetHashCode ( )

Returns the hash code of this object.

Returns
A 32-bit signed integer hash code.

Definition at line 112 of file ArgIterator.cs.

◆ GetNextArg() [1/2]

unsafe TypedReference System.ArgIterator.GetNextArg ( )

Returns the next argument in a variable-length argument list.

Returns
The next argument as a T:System.TypedReference object.
Exceptions
T:System.InvalidOperationExceptionAn attempt was made to read beyond the end of the list.

Definition at line 50 of file ArgIterator.cs.

◆ GetNextArg() [2/2]

unsafe TypedReference System.ArgIterator.GetNextArg ( RuntimeTypeHandle  rth)

Returns the next argument in a variable-length argument list that has a specified type.

Parameters
rthA runtime type handle that identifies the type of the argument to retrieve.
Returns
The next argument as a T:System.TypedReference object.
Exceptions
T:System.InvalidOperationExceptionAn attempt was made to read beyond the end of the list.
T:System.ArgumentNullExceptionThe pointer to the remaining arguments is zero.

Definition at line 68 of file ArgIterator.cs.

◆ GetNextArgType()

unsafe RuntimeTypeHandle System.ArgIterator.GetNextArgType ( )

Returns the type of the next argument.

Returns
The type of the next argument.

Definition at line 105 of file ArgIterator.cs.

◆ GetRemainingCount()

int System.ArgIterator.GetRemainingCount ( )

Returns the number of arguments remaining in the argument list.

Returns
The number of remaining arguments.

The documentation for this struct was generated from the following file: