Marshal.GetActiveObject(String) Метод

Определение

Пространство имен:

System.Runtime.InteropServices

Сборка:

mscorlib.dll

Получает выполняющийся экземпляр указанного объекта из таблицы запущенных объектов (ROT).

public:
 static System::Object ^ GetActiveObject(System::String ^ progID);

[System.Security.SecurityCritical]
public static object GetActiveObject (string progID);

[<System.Security.SecurityCritical>]
static member GetActiveObject : string -> obj

Public Shared Function GetActiveObject (progID As String) As Object

Параметры

progID

String

Программный идентификатор (ProgID) запрошенного объекта.

Возвращаемое значение

Object

Запрошенный объект; в противном случае — значение null. Этот объект может быть приведен к любому интерфейсу COM, поддерживаемому этим объектом.

Атрибуты

SecurityCriticalAttribute

Исключения

COMException

Объект не найден.

Примеры

Следующий пример был запущен на компьютере, на котором был настроен работающий экземпляр Microsoft Word. Экземпляры Microsoft Excel не выполнялись.

В примере вызывается GetActiveObject дважды. Первый вызов пытается получить ссылку на экземпляр Microsoft Word (экземпляр Word.Application объекта ). Второй вызов пытается получить ссылку на экземпляр Microsoft Excel (экземпляр Excel.Application объекта).

Код успешно извлекает ссылку на экземпляр Microsoft Word. Однако, поскольку Microsoft Excel не запущен, попытка получить второй объект вызывает .COMException

using System;
using System.Runtime.InteropServices;

class MainFunction
{
    static void Main()
        {
        Console.WriteLine("\nSample: C# System.Runtime.InteropServices.Marshal.GetActiveObject.cs\n"); 

        GetObj(1, "Word.Application");
        GetObj(2, "Excel.Application");
        }

    static void GetObj(int i, String progID)
    {
        Object obj = null;

        Console.WriteLine("\n" +i+") Object obj = GetActiveObject(\"" + progID + "\")");
        try
           { obj = Marshal.GetActiveObject(progID); }
        catch (Exception e)
           {
           Write2Console("\n   Failure: obj did not get initialized\n" + 
                         "   Exception = " +e.ToString().Substring(0,43), 0); 
           }
 
        if (obj != null)
           { Write2Console("\n   Success: obj = " + obj.ToString(), 1 ); }
    }

    static void Write2Console(String s, int color)
        {
        Console.ForegroundColor = color == 1? ConsoleColor.Green : ConsoleColor.Red;
        Console.WriteLine(s); 
        Console.ForegroundColor = ConsoleColor.Gray;
    }
}

/*
Expected Output:

Sample: C# System.Runtime.InteropServices.Marshal.GetActiveObject.cs

1) Object obj = GetActiveObject("Word.Application")

   Success: obj = System.__ComObject

2) Object obj = GetActiveObject("Excel.Application")

   Failure: obj did not get initialized
   Exception = System.Runtime.InteropServices.COMException
*/

Imports System.Runtime.InteropServices

Module Module1

    Sub Main()
        Console.WriteLine(vbcrlf + "Sample: VB System.Runtime.InteropServices.Marshal.GetActiveObject.vb" + vbcrlf) 
        GetObj(1, "Word.Application")
        GetObj(2, "Excel.Application")
    End Sub


    Sub GetObj(ByVal i As Integer, ByVal progID As [String])
        Dim obj As [Object] = Nothing
        
        Console.WriteLine((vbLf & i & ") Object obj = GetActiveObject(""") + progID & """)")
        Try
            obj = Marshal.GetActiveObject(progID)
        Catch e As Exception
            Write2Console((vbLf & "   Failure: obj did not get initialized" & vbLf & "   Exception = ") + e.ToString().Substring(0, 43), 0)
        End Try
        
        If obj IsNot Nothing Then
            Write2Console(vbLf & "   Success: obj = " & obj.ToString(), 1)
        End If
    End Sub

    Sub Write2Console(ByVal s As [String], ByVal color As Integer)
        Console.ForegroundColor = If(color = 1, ConsoleColor.Green, ConsoleColor.Red)
        Console.WriteLine(s)
        Console.ForegroundColor = ConsoleColor.Gray
    End Sub

End Module

'Expected Output:
'
'Sample: VB System.Runtime.InteropServices.Marshal.GetActiveObject.vb
'
'1) Object obj = GetActiveObject("Word.Application")
'
'   Success: obj = System.__ComObject
'
'2) Object obj = GetActiveObject("Excel.Application")
'
'   Failure: obj did not get initialized
'   Exception = System.Runtime.InteropServices.COMException
'

Комментарии

Дополнительные сведения об этом API см. в разделе Дополнительные примечания API для Marshal.GetActiveObject.