GetTypeFromProgID Method (String, String, Boolean)
Collapse the table of content
Expand the table of content

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)

public:
[SecurityCriticalAttribute]
static Type^ GetTypeFromProgID(
	String^ progID,
	String^ server,
	bool 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 null, 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, null.

Exception Condition
ArgumentException

progID is null.

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.

using namespace System;
int main()
{
   try
   {

      // Use server localhost.
      String^ theServer = "localhost";

      // Use  ProgID HKEY_CLASSES_ROOT\DirControl.DirList.1.
      String^ myString1 = "DirControl.DirList.1";

      // Use a wrong ProgID WrongProgID.
      String^ myString2 = "WrongProgID";

      // Make a call to the method to get the type information for the given ProgID.
      Type^ myType1 = Type::GetTypeFromProgID( myString1, theServer, true );
      Console::WriteLine( "GUID for ProgID DirControl.DirList.1 is {0}.", myType1->GUID );

      // Throw an exception because the ProgID is invalid and the throwOnError
      // parameter is set to True.
      Type^ myType2 = Type::GetTypeFromProgID( myString2, theServer, true );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "An exception occurred. The ProgID is wrong." );
      Console::WriteLine( "Source: {0}", e->Source );
      Console::WriteLine( "Message: {0}", e->Message );
   }

}

SecurityCriticalAttribute

Requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft