VB & VBA in a Nutshell: The Language

GetObject Function

Named Arguments

Yes

Syntax

GetObject([pathname] [, class])

pathname

Use: Optional

Data Type: Variant (String)

The full path and name of the file containing the ActiveX object.

class

Use: Optional

Data Type: Variant (String)

The class of the object (see next list).

The class argument has these parts:

Appname

Use: Required

Data Type: Variant (String)

The name of the application.

Objecttype

Use: Required

Data Type: Variant (String)

The class of object to create, delimited from Appname by using a point (.). For example, Appname.Objecttype.

Return Value

Returns a reference to an ActiveX object.

Description

Accesses an ActiveX server held within a specified file.

Rules at a Glance

• Although both pathname and class are optional, at least one parameter must be supplied.

• In situations in which you can't create a project-level reference to an ActiveX object, you can use the GetObject function to assign an object reference from an external ActiveX object to an object variable.

• GetObject is used when there is a current instance of the ActiveX object; to create the instance, use the CreateObject function.

• If you specify pathname as a zero-length string, GetObject returns a new instance of the object—unless the object is registered as single instance, in which case the current instance is returned.

• If you omit the pathname, the current instance of the object is returned.

• An error is generated if pathname isn't specified, and no current instance of the object can be found. ...