Interaction.GetObject(String, String) Método

Definição

Namespace:

Microsoft.VisualBasic

Assembly:

Microsoft.VisualBasic.Core.dll

Origem:

Interaction.vb

Retorna uma referência a um objeto fornecido por um componente COM.

[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public static object? GetObject (string? PathName = default, string? Class = default);

[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
static member GetObject : string * string -> obj

Public Function GetObject (Optional PathName As String = Nothing, Optional Class As String = Nothing) As Object

Parâmetros

PathName

String

Opcional. String. O nome e caminho completo do arquivo que contém o objeto a ser recuperado. Se PathName for omitido, Class será necessário.

Class

String

Necessário se PathName não for fornecido. String. Uma cadeia de caracteres que representa a classe do objeto. O argumento Class tem a sintaxe e as partes a seguir:

appname.objecttype

[1|1] Parâmetro

[1|2] Descrição

[2|1] appname

[2|2] Necessário. String. O nome do aplicativo que fornece o objeto.

[3|1] objecttype

[3|2] Necessário. String. O tipo ou a classe de objeto a ser criado.

Retornos

Object

Uma referência a um objeto fornecido por um componente COM.

Atributos

SupportedOSPlatformAttribute

Exceções

Exception

Não existe nenhum objeto do tipo de classe especificado.

FileNotFoundException

Não existe nenhum objeto com o caminho e nome de arquivo especificados.

Exemplos

O exemplo a seguir usa a GetObject função para obter uma referência a uma planilha específica do Microsoft Excel (excelObj). Ele usa a propriedade da Application planilha para tornar o Excel visível, fechá-la e executar outras ações. Usando duas chamadas à API, o detectExcel procedimento procura o Excel e, se ele estiver em execução, insere-o na tabela Objeto em Execução. A primeira chamada para GetObject causará um erro se o Excel ainda não estiver em execução, o que neste exemplo faz com que o excelWasNotRunning sinalizador seja definido Truecomo . A segunda chamada para GetObject especifica um arquivo a ser aberto. Se o Excel ainda não estiver em execução, a segunda chamada a iniciará e retornará uma referência à planilha representada pelo arquivo especificado, test.xls. O arquivo deve existir no local especificado; caso contrário, o Visual Basic lançará um FileNotFoundException. Em seguida, o código de exemplo torna o Excel e a janela que contém a planilha especificada visíveis.

Este exemplo requer Option Strict Off porque ele usa associação tardia, em que objetos são atribuídos a variáveis do tipo Object. Você pode especificar Option Strict On e declarar objetos de tipos de objeto específicos se adicionar uma referência à biblioteca de tipos do Excel na guia COM da caixa de diálogo Adicionar Referência do menu Projeto no Visual Studio.

' Add Option Strict Off to the top of your program.
Option Strict Off

' Test to see if a copy of Excel is already running.
Private Sub testExcelRunning()
    On Error Resume Next
    ' GetObject called without the first argument returns a
    ' reference to an instance of the application. If the
    ' application is not already running, an error occurs.
    Dim excelObj As Object = GetObject(, "Excel.Application")
    If Err.Number = 0 Then
        MsgBox("Excel is running")
    Else
        MsgBox("Excel is not running")
    End If
    Err.Clear()
    excelObj = Nothing
End Sub

Private Sub getExcel()
    Dim fileName As String = "c:\vb\test.xls"

    If Not My.Computer.FileSystem.FileExists(fileName) Then
        MsgBox(fileName & " does not exist")
        Exit Sub
    End If

    ' Set the object variable to refer to the file you want to use.
    Dim excelObj As Object = GetObject(fileName)
    ' Show Excel through its Application property. 
    excelObj.Application.Visible = True
    ' Show the window containing the file.
    Dim winCount As Integer = excelObj.Parent.Windows.Count()
    excelObj.Parent.Windows(winCount).Visible = True

    ' Insert additional code to manipulate the test.xls file here.
    ' ...

    excelObj = Nothing
End Sub

Quando você chama a getExcel função, uma verificação é feita para ver se o Excel já está em execução. Se não estiver, uma instância será criada.

Importante

Para simplificar, o exemplo anterior pressupõe que qualquer janela chamada XLMAIN pertence a uma instância do Microsoft Excel. Se outro objeto, possivelmente iniciado por adulteração ilícita, criasse uma janela com esse nome, ele receberia todas as mensagens que você pretendia para o Excel. Em um aplicativo a ser usado para produção, você deve incluir alguns testes mais rigorosos para verificar se realmente XLMAIN pertence ao Excel.

Comentários

Use a GetObject função para carregar uma instância de um componente COM de um arquivo. O exemplo a seguir ilustra essa situação.

Dim CADObject As Object  
CADObject = GetObject("C:\CAD\schema.cad")  

Quando esse código é executado, o aplicativo associado ao especificado PathName é iniciado e o objeto no arquivo especificado é ativado.

Casos Padrão

Se PathName for uma cadeia de caracteres de comprimento zero (""), GetObject retornará uma nova instância de objeto do tipo de classe especificado. Se o PathName argumento for omitido, GetObject retornará um objeto ativo no momento do tipo de classe especificado em Class. Se nenhum objeto do tipo especificado existir, ocorrerá um erro.

Acessando um subobjeto

Alguns aplicativos permitem que você ative um subobjeto associado a um arquivo. Para fazer isso, adicione um ponto de exclamação (!) ao final do nome do arquivo e siga-o com uma cadeia de caracteres que identifica a parte do arquivo que você deseja ativar. Para obter informações sobre como criar essa cadeia de caracteres, consulte a documentação do aplicativo que criou o objeto.

Por exemplo, em um aplicativo de desenho, você pode ter várias camadas para um desenho armazenado em um arquivo. Você pode usar o código a seguir para ativar uma camada dentro de um desenho chamado schema.cad.

layerObject = GetObject("C:\CAD\schema.cad!Layer3")  

Especificando uma classe

Se você não especificar o do Classobjeto , a Automação determinará o aplicativo a ser iniciado e o objeto a ser ativado, com base no nome do arquivo fornecido. Alguns arquivos, no entanto, podem dar suporte a mais de uma classe de objeto. Por exemplo, um desenho pode dar suporte a três tipos diferentes de objetos: um Application objeto, um Drawing objeto e um Toolbar objeto, todos eles fazem parte do mesmo arquivo. Para especificar qual objeto em um arquivo você deseja ativar, use o argumento opcional Class . O exemplo a seguir ilustra essa situação.

Dim drawObj As Object  
drawObj = GetObject("C:\Drawings\sample.drw", "Figment.Drawing")  

No exemplo anterior, Figment é o nome de um aplicativo de desenho e Drawing é um dos tipos de objeto compatíveis.

Usando o objeto

Depois que um objeto é ativado, você faz referência a ele no código usando a variável de objeto que você declarou. No exemplo anterior, você acessa propriedades e métodos do novo objeto usando a variável drawObjde objeto . O exemplo a seguir ilustra essa situação.

drawObj.Line(9, 90)  
drawObj.InsertText(9, 100, "Hello, world.")  
drawObj.SaveAs("C:\Drawings\sample.drw")  

Observação

Use a GetObject função quando houver uma instância atual do objeto ou se você quiser criar o objeto com um arquivo carregado. Se não houver nenhuma instância atual e você não quiser que o objeto seja iniciado com um arquivo carregado, use a CreateObject função .

Se um objeto tiver se registrado como um objeto de instância única ActiveX, apenas uma instância do objeto será criada, independentemente de quantas vezes CreateObject for chamada. Com um objeto de instância única, GetObject sempre retorna a mesma instância quando chamado com a sintaxe de cadeia de caracteres de comprimento zero ("") e causa um erro se o PathName argumento for omitido. Você não pode usar GetObject para obter uma referência a uma classe criada com o Visual Basic.

Importante

A GetObject função requer permissão de código não gerenciada, o que pode afetar sua execução em situações de confiança parcial. Para obter mais informações, consulte SecurityPermission e Permissões de Acesso de Código.

Confira também

• CreateObject(String, String)
• Exception
• FileNotFoundException
• Instrução Declare
• Instrução Option Strict