This documentation is archived and is not being maintained.

Type.GetTypeFromProgID Method (String, String, Boolean)

Gets the type associated with the specified program identifier (progID) from the specified server, specifying whether to throw an exception if an error occurs while loading the type.

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

'Declaration
<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags := SecurityPermissionFlag.UnmanagedCode)> _
Public Shared Function GetTypeFromProgID ( _
	progID As String, _
	server As String, _
	throwOnError As Boolean _
) As Type
'Usage
Dim progID As String 
Dim server As String 
Dim throwOnError As Boolean 
Dim returnValue As Type 

returnValue = Type.GetTypeFromProgID(progID, _
	server, throwOnError)

Parameters

progID
Type: System.String

The progID of the Type to get.

server
Type: System.String

The server from which to load the type. If the server name is Nothing, this method automatically reverts to the local machine.

throwOnError
Type: System.Boolean

true to throw any exception that occurs.

-or-

false to ignore any exception that occurs.

Return Value

Type: System.Type
The Type associated with the specified program identifier (progID), if progID is a valid entry in the registry and a type is associated with it; otherwise, Nothing.

ExceptionCondition
ArgumentException

progID is Nothing.

COMException

The specified progID is not registered.

This method is provided for COM support. Program IDs are not used in Microsoft .NET Framework because they have been superseded by the concept of namespace.

The following example retrieves a type by passing a ProgID and server name. The example then displays the ClassID related to the ProgID, specifying whether to throw an exception if the ProgID or the server name is invalid.

Imports System
Class MainApp
    Public Shared Sub Main()
        Try 
            ' Use Server localhost. 
            Dim theServer As String = "localhost" 
            ' Use  ProgID HKEY_CLASSES_ROOT\DirControl.DirList.1. 
            Dim myString1 As String = "DirControl.DirList.1" 
            ' Use a wrong ProgID WrongProgID. 
            Dim myString2 As String = "WrongProgID" 
            ' Make a call to the method to get the type information for the given ProgID. 
            Dim myType1 As Type = Type.GetTypeFromProgID(myString1, theServer, True)
            Console.WriteLine("GUID for ProgID DirControl.DirList.1 is {0}.", myType1.GUID.ToString())
            ' Throw an exception because the ProgID is invalid and the throwOnError  
            ' parameter is set to True. 
            Dim myType2 As Type = Type.GetTypeFromProgID(myString2, theServer, True)
        Catch e As Exception
            Console.WriteLine("An exception occurred. The ProgID is wrong.")
            Console.WriteLine("Source: {0}", e.Source.ToString())
            Console.WriteLine("Message: {0}", e.Message.ToString())
        End Try 
    End Sub 'Main 
End Class 'MainApp

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

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: