Função GetObject

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

Sintaxe

GetObject([ pathname ], [ class ])

A sintaxe da função GetObject tem estes argumentos nomeados:

Parte Descrição
nomedocaminho Opcional; Variant (Cadeia). O caminho completo e o nome do arquivo que contém o objeto a ser recuperado. Se pathname for omitido, a classe será necessária.
classe Opcional; Variant (Cadeia). Uma cadeia de caracteres que representa a classe do objeto.

O argumento classe usa a sintaxe appname.objecttype e tem os seguintes partes:

Parte Descrição
appname Obrigatório; Variant (Cadeia). O nome do aplicativo que fornece o objeto.
objectType Obrigatório; Variant (Cadeia). O tipo ou classe do objeto a ser criado.

Comentários

Use a função GetObject para acessar um objeto ActiveX de um arquivo e atribuir o objeto a uma variável de objeto. Use a instrução Set para atribuir o objeto retornado por GetObject à variável de objeto. Por exemplo:

Dim CADObject As Object
Set CADObject = GetObject("C:\CAD\SCHEMA.CAD")

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

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

Alguns aplicativos permitem que você ative parte de um arquivo. 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:

Set LayerObject = GetObject("C:\CAD\SCHEMA.CAD!Layer3")

Se você não especificar a classe do objeto, a automação determinará o aplicativo para iniciar e o objeto a ser ativado, com base no nome do arquivo que você fornece. 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 objeto Application , um objeto Drawing e um objeto Toolbar , todos eles fazem parte do mesmo arquivo. Para especificar qual objeto em um arquivo que você deseja ativar, use o argumento classe opcional. Por exemplo:

Dim MyObject As Object
Set MyObject = GetObject("C:\DRAWINGS\SAMPLE.DRW", "FIGMENT.DRAWING")

No exemplo, é FIGMENT o nome de um aplicativo de desenho e DRAWING é um dos tipos de objeto compatíveis. Depois que um objeto for ativado, você o referencia no código usando a variável de objeto definida. No exemplo anterior, você acessa propriedades e métodos do novo objeto usando a variável de objeto MyObject. Por exemplo:

MyObject.Line 9, 90
MyObject.InsertText 9, 100, "Hello, world."
MyObject.SaveAs "C:\DRAWINGS\SAMPLE.DRW"

Observação

Use a função GetObject quando houver uma instância atual do objeto ou se você quiser criar o objeto com um arquivo já 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 função CreateObject .

Se um objeto se registrou como um objeto de instância única, apenas uma instância do objeto é criada, independentemente de quantas vezes o CreateObject for executado. 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 argumento pathname for omitido. Não é possível usar GetObject para obter uma referência a uma classe criada com Visual Basic.

Exemplo

Este exemplo usa a função GetObject para obter uma referência a uma planilha Microsoft Excel específica (MyXL). Ele usa a propriedade Application da planilha para Microsoft Excel visível, para fechar e assim por diante.

Usando duas chamadas de API, DetectExcel o procedimento Sub procura por Microsoft Excel e, se estiver em execução, a inserirá na Tabela de Objetos Em Execução.

A primeira chamada para GetObject causará um erro se Microsoft Excel ainda não estiver em execução. No exemplo, o erro faz com que o ExcelWasNotRunning sinalizador seja definido como True.

A segunda chamada para GetObject especifica um arquivo a ser aberto. Se Microsoft Excel já não estiver em execução, a segunda chamada a iniciará e retornará uma referência à planilha representada pelo arquivo especificado, mytest.xls. O arquivo deve existir no local especificado; caso contrário, o Visual Basic erro Automation error é gerado.

Em seguida, o código de exemplo torna Microsoft Excel e a janela que contém a planilha especificada visível. Por fim, se não houver nenhuma versão anterior Microsoft Excel em execução, o código usará o método Quit do objeto Application para fechar Microsoft Excel. Se o aplicativo já estava em execução, nenhuma tentativa é feita para o fechar. A referência em si é lançada definindo-a como Nothing.

' Declare necessary API routines:
Declare Function FindWindow Lib "user32" Alias _
"FindWindowA" (ByVal lpClassName as String, _
                    ByVal lpWindowName As Long) As Long

Declare Function SendMessage Lib "user32" Alias _
"SendMessageA" (ByVal hWnd as Long,ByVal wMsg as Long, _
                    ByVal wParam as Long, _
                    ByVal lParam As Long) As Long

Sub GetExcel()
    Dim MyXL As Object    ' Variable to hold reference
                                ' to Microsoft Excel.
    Dim ExcelWasNotRunning As Boolean    ' Flag for final release.

' Test to see if there is a copy of Microsoft Excel already running.
    On Error Resume Next    ' Defer error trapping.
' Getobject function called without the first argument returns a 
' reference to an instance of the application. If the application isn't
' running, an error occurs.
    Set MyXL = Getobject(, "Excel.Application")
    If Err.Number <> 0 Then ExcelWasNotRunning = True
    Err.Clear    ' Clear Err object in case error occurred.

' Check for Microsoft Excel. If Microsoft Excel is running,
' enter it into the Running Object table.
    DetectExcel

' Set the object variable to reference the file you want to see.
    Set MyXL = Getobject("c:\vb4\MYTEST.XLS")

' Show Microsoft Excel through its Application property. Then
' show the actual window containing the file using the Windows
' collection of the MyXL object reference.
    MyXL.Application.Visible = True
    MyXL.Parent.Windows(1).Visible = True
     Do manipulations of your  file here.
    ' ...
' If this copy of Microsoft Excel was not running when you
' started, close it using the Application property's Quit method.
' Note that when you try to quit Microsoft Excel, the
' title bar blinks and a message is displayed asking if you
' want to save any loaded files.
    If ExcelWasNotRunning = True Then 
        MyXL.Application.Quit
    End IF

    Set MyXL = Nothing    ' Release reference to the
                                ' application and spreadsheet.
End Sub

Sub DetectExcel()
' Procedure dectects a running Excel and registers it.
    Const WM_USER = 1024
    Dim hWnd As Long
' If Excel is running this API call returns its handle.
    hWnd = FindWindow("XLMAIN", 0)
    If hWnd = 0 Then    ' 0 means Excel not running.
        Exit Sub
    Else                
    ' Excel is running so use the SendMessage API 
    ' function to enter it in the Running Object Table.
        SendMessage hWnd, WM_USER + 18, 0, 0
    End If
End Sub

Confira também

Suporte e comentários

Tem dúvidas ou quer enviar comentários sobre o VBA para Office ou sobre esta documentação? Confira Suporte e comentários sobre o VBA para Office a fim de obter orientação sobre as maneiras pelas quais você pode receber suporte e fornecer comentários.