GetActiveOleObject

f90VB Modules

f90VBDefs, f90VBVariants, f90VBAutomation

Summary

GetActiveOleObject returns a variant containing a reference to the IDispatch interface of the active object for the class indicated in ObjRef.

Syntax

type(VARIANT) function GetActiveOleObject

(ObjRef, iRet)

{
character(len=*),intent(in)::	ObjRef \|
type(GUID),intent(in)::	ObjRef
}
integer(HRESULT_KIND),intent(out),optional::	iRet

Arguments

ObjRef [Input]

Can be either the Programmatic Identifier (ProgID) of the object or the CoClass Identifier (CLSID) of the object.

iRet [Output/Optional]

Upon return, iRet contains S_OK or a negative error code. See comments for more information.

Comments

ObjRef is the programmatic ID for the class of the active object from the OLE running object table or the CLSID (CoClass ID) of the object. GetActiveOleObject is used to access the OLE running objects table. If the requested object has not registered itself in the OLE running Objects table (or if the object is not currently loaded in memory), GetActiveOleObject returns with an error condition.

Examples

See examples in Chapter 6 - User Manual

For information about:	See:
Creating an object	CreateOleObject
Creating a remote object	CreateRemoteOleObject