Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Type.MakeByRefType Method

Note: This method is new in the .NET Framework version 2.0.

Returns a Type object that represents the current type when passed as a ref parameter (ByRef parameter in Visual Basic).

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

public:
virtual Type^ MakeByRefType ()
public Type MakeByRefType ()
public function MakeByRefType () : Type

Return Value

A Type object that represents the current type when passed as a ref parameter (ByRef parameter in Visual Basic).

The MakeByRefType method provides a way to generate ref types (ByRef in Visual Basic) for parameter lists.

Using the syntax of Microsoft intermediate language (MSIL), if the current Type object represents Int32, this method returns a Type object representing Int32&.

The following code example creates array, ref (ByRef in Visual Basic), and pointer types for the Test class.

using namespace System;
using namespace System::Reflection;

public ref class Example
{
public:
   static void Main()
   {
      // Create a Type object that represents a one-dimensional
      // array of Example objects.
      Type^ t = Example::typeid->MakeArrayType();
      Console::WriteLine( L"\r\nArray of Example: {0}", t );
      
      // Create a Type object that represents a two-dimensional
      // array of Example objects.
      t = Example::typeid->MakeArrayType( 2 );
      Console::WriteLine( L"\r\nTwo-dimensional array of Example: {0}", t );
      
      // Demonstrate an exception when an invalid array rank is
      // specified.
      try
      {
         t = Example::typeid->MakeArrayType(  -1 );
      }
      catch ( Exception^ ex ) 
      {
         Console::WriteLine( L"\r\n{0}", ex );
      }
      
      // Create a Type object that represents a ByRef parameter
      // of type Example.
      t = Example::typeid->MakeByRefType();
      Console::WriteLine( L"\r\nByRef Example: {0}", t );
      
      // Get a Type object representing the Example class, a
      // MethodInfo representing the "Test" method, a ParameterInfo
      // representing the parameter of type Example, and finally
      // a Type object representing the type of this ByRef parameter.
      // Compare this Type object with the Type object created using
      // MakeByRefType.
      Type^ t2 = Example::typeid;
      MethodInfo^ mi = t2->GetMethod( L"Test" );
      ParameterInfo^ pi = mi->GetParameters()[ 0 ];
      Type^ pt = pi->ParameterType;
      Console::WriteLine( L"Are the ByRef types equal? {0}", (t == pt) );
      
      // Create a Type object that represents a pointer to an
      // Example object.
      t = Example::typeid->MakePointerType();
      Console::WriteLine( L"\r\nPointer to Example: {0}", t );
   }

   // A sample method with a ByRef parameter.
   //
   void Test( interior_ptr<Example^> /*e*/ )
   {
   }
};

int main()
{
   Example::Main();
}

/* This example produces output similar to the following:

Array of Example: Example[]

Two-dimensional array of Example: Example[,]

System.IndexOutOfRangeException: Index was outside the bounds of the array.
   at System.RuntimeType.MakeArrayType(Int32 rank) in c:\vbl\ndp\clr\src\BCL\System\RtType.cs:line 2999
   at Example.Main()

ByRef Example: Example&
Are the ByRef types equal? True

Pointer to Example: Example*

 */

import System.*;
import System.Reflection.*;

public class Example
{
    public static void main(String[] args)
    {
        // Create a Type object that represents a one-dimensional
        // array of Example objects.
        Type t = Example.class.ToType().MakeArrayType();
        Console.WriteLine("\r\nArray of Example: {0}", t);
        // Create a Type object that represents a two-dimensional
        // array of Example objects.
        t = Example.class.ToType().MakeArrayType(2);
        Console.WriteLine("\r\nTwo-dimensional array of Example: {0}", t);
        // Demonstrate an exception when an invalid array rank is
        // specified.
        try {
            t = Example.class.ToType().MakeArrayType(-1);
        }
        catch (System.Exception ex) {
            Console.WriteLine("\r\n{0}", ex);
        }
        // Create a Type object that represents a ByRef parameter
        // of type Example.
        t = Example.class.ToType().MakeByRefType();
        Console.WriteLine("\r\nByRef Example: {0}", t);
        // Get a Type object representing the Example class, a
        // MethodInfo representing the "Test" method, a ParameterInfo
        // representing the parameter of type Example, and finally
        // a Type object representing the type of this ByRef parameter.
        // Compare this Type object with the Type object created using
        // MakeByRefType.
        Type t2 = Example.class.ToType();
        MethodInfo mi = t2.GetMethod("Test");
        ParameterInfo pi = mi.GetParameters()[0];
        Type pt = pi.get_ParameterType();
        Console.WriteLine("Are the ByRef types equal? {0}", new 
            Boolean(t == pt));
        // Create a Type object that represents a pointer to an
        // Example object.
        t = Example.class.ToType().MakePointerType();
        Console.WriteLine("\r\nPointer to Example: {0}", t);
    } //main

    // A sample method with a ByRef parameter.
    //
    public void Test(Example e)
    {
    } //Test
} //Example

/* This example produces output similar to the following:

Array of Example: Example[]

Two-dimensional array of Example: Example[,]

System.IndexOutOfRangeException: Index was outside the bounds of the array.
   at System.RuntimeType.MakeArrayType(Int32 rank) in c:\vbl\ndp\clr\src\BCL\
   System\RtType.jsl:line 2999
   at Example.main()

ByRef Example: Example&
Are the ByRef types equal? false

Pointer to Example: Example*

 */

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.