GetObject-funktio

Palauttaa tuloksena viittauksen ActiveX-komponentin järjestämään objektiin.

Syntaksi

GetObject([ polku ] [, luokka ] )

GetObject-funktion syntaksilla on seuraavat argumentit:

Argumentti	Kuvaus
polkunimi	Valinnainen. Muuttuja (merkkijono). Haettavan objektin sisältävän tiedoston koko polku ja nimi. Jos polkunimi jätetään pois, luokka on pakollinen.
luokka	Valinnainen. Muuttuja (merkkijono). Objektin luokkaa edustava merkkijono.

Luokka-argumenttikäyttää syntaksia appname.objecttype ja sisältää seuraavat osat:

Osa	Kuvaus
sovelluksen nimi	Pakollinen. Muuttuja (merkkijono). Sen sovelluksen nimi, joka toimittaa objektin.
objektilaji	Pakollinen. Muuttuja (merkkijono). Luotavan objektin laji tai luokka.

Huomautuksia

GetObject-funktion avulla pääset käyttämään ActiveX-objektia tiedostosta ja voit määrittää objektin objektimuuttujaan. Käyttämällä Set-lauseketta voit määrittää GetObject-funktion toimittaman objektin. Esimerkki:

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

Kun tämä koodi suoritetaan, määritettyyn polkuun liittyvä sovellus käynnistetään ja määritetyssä tiedostossa oleva objekti aktivoidaan.

Jos polkunimi on tyhjä merkkijono (""), GetObject palauttaa uuden määritettyä tyyppiä edustavan objektiesiintymän. Jos polkunimi-argumentti jätetään pois, GetObject palauttaa määritetyn tyypin aktiivisena olevan objektin. Jos saatavilla ei ole määritetyn tyyppistä objektia, tapahtuu virhe.

Joidenkin sovellusten avulla voit aktivoida osan tiedostosta. Lisää huutomerkki (!) tiedostonimen loppuun ja lisää sen jälkeen merkkijono, joka määrittää, minkä osan tiedostosta haluat aktivoida. Lisätietoja tämän merkkijonon luomisesta on objektin luoneen sovelluksen ohjeissa.

Esimerkiksi piirustussovelluksessa tiedosto saattaa sisältää useita piirustuksen kerroksia. Voit käyttää seuraavaa koodia aktivoidaksesi piirustuksessa olevan kerroksen nimeltä SCHEMA.CAD:

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

Jos et määritä objektin luokkaa, automaatio määrittelee käynnistettävän sovelluksen ja aktivoitavan objektin antamasi tiedostonimen perusteella. Eräät tiedostot voivat kuitenkin tukea useita objektiluokkia. Esimerkiksi piirustus voi tukea kolmea eri objektityyppiä: Sovellus-objektia, Piirustus-objektia ja Työkalurivi-objektia, jolloin kaikki ovat osa samaa tiedostoa. Määritä, minkä tiedoston objektin haluat aktivoida, käyttämällä valinnaista luokka-argumenttia . Esimerkki:

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

Esimerkissä FIGMENT se on piirustussovelluksen nimi ja DRAWING yksi sen tukemista objektilajeista.

Kun objekti on aktivoitu, voit koodissa viitata siihen määrittelemääsi objektimuuttujaa käyttämällä. Edellisessä esimerkissä voit käyttää uuden objektin ominaisuuksia ja menetelmiä objektimuuttujan MyObjectavulla. Esimerkki:

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

Jos objekti on rekisteröitynyt yhden esiintymän objektina, luodaan vain yksi objektiesiintymä riippumatta siitä, montako kertaa CreateObject suoritetaan. Yhden esiintymän objekteissa GetObject palauttaa aina saman esiintymän, kun sitä kutsutaan tyhjän merkkijonon ("") syntaksilla, ja se aiheuttaa virheen, jos polkunimi-argumentti jätetään pois. GetObject-funktiolla ei voida saada viittausta Visual Basicilla luotuun luokkaan.

Esimerkki

Tässä esimerkissä GetObject-funktiolla saadaan viittaus tiettyyn Excel-laskentataulukkoon ().MyXL Se käyttää laskentataulukon Sovellus-ominaisuutta Excelin tekemiseen näkyväksi, sulkemiseen jne. Käyttämällä kahta API-kutsua DetectExcel-alitoimintosarja hakee Exceliä, ja jos se on käynnissä, lisää sen suoritettavien objektien taulukkoon. Ensimmäinen kutsu GetObjectille aiheuttaa virheen, ellei Microsoft Excel ole jo käynnissä. Esimerkissä virhe aiheuttaa ExcelWasNotRunning-merkinnän arvoksi Tosi. Toinen kutsu GetObjectille määrittää avattavan tiedoston. Jos Excel ei ole käynnissä, toinen kutsu käynnistää sen ja antaa viittauksen määritetyn tiedoston edustamaan laskentataulukkoon, mytest.xls. Tiedoston on oltava olemassa ja löydyttävä määritetystä sijainnista, muuten syntyy Visual Basicin automaatiovirhe. Seuraavaksi esimerkkikoodi tekee sekä Excelin että määritetyn laskentataulukon näkyviksi. Jos käynnissä ei ole aikaisempaa Excel-versiota, koodi sulkee Excelin sovellusobjektinQuit-menetelmällä . Jos sovellus oli alun pitäenkin käynnissä, sitä ei yritetä sulkea. Viittaus vapautetaan asettamalla se arvoon Ei mitään.

' 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