OLEObject object

The OLEObject object acts as a proxy for a remote OLE object.

You can customize your own version of the OLEObject object by
defining a standard class user object inherited from the built-in
OLEObject. You can then access the OLEObject Constructor, Destructor,
Error, and ExternalException events by writing scripts that contain code
for the events.

Coding Error and ExternalException events

If you code the Error and ExternalException events, any active
exception handler for a RuntimeError will not be processed. However, you
can throw an exception in the scripts for these events, and you can make
the arguments of these events available for exception handling by
putting the arguments in a string in a throw statement that passes the
string to the exception handler.

OLEObject objects are displayed in the OLE tab of the Browser as
Programmable Objects.

For more information about creating a custom OLEObject object, see
the section called “Working with User Objects” in Users Guide.

For more information about using the OLEObject object in an
application, see the section called “Using OLE in an Application” in Application Techniques.

OLEObject is a dynamic object

In order to support OLE, OLEObject is a dynamic object. The
PowerBuilder compiler accept property names and function names and
parameter lists that are not already defined for the object. If the
properties or functions do not exist during execution, you get a runtime
error.

Properties

OLEObject property	Datatype	Description
ClassDefinition	PowerObject	An object of type PowerObject containing information about the class definition of the object or control.
Handle	Objhandle	Internal use only.

Events

OLEObject event	Occurs
Constructor	When the user object is created.
Destructor	When the user object is destroyed.
Error	When an error is found in a data or property expression for an external object.
ExternalException	When the evaluation of an expression involving properties of an external object causes an error. This type of event occurs before the Error event.

Functions

OLEObject function	Datatype returned	Description
ClassName	String	Returns the name assigned to the user object
ConnectToNewObject	Integer	Creates a new instance of the class and connects to it
ConnectToNewRemoteObject	Integer	Creates a new OLE object in the specified remote server application and associates the new object with a PowerBuilder OLEObject variable
ConnectToObject	Integer	Opens a specified file and connects to the corresponding server application
ConnectToRemoteObject	Integer	Associates an OLE object with a PowerBuilder OLEObject variable and starts the server application
DisconnectObject	Integer	Releases all objects previously connected
GetAutomationNativePointer	Integer	Returns a pointer to the underlying OLE object
GetContextService	Integer	Creates a reference to a context-specific instance of the specified service
GetParent	PowerObject	Returns a reference to the name of the parent object
IsAlive	Boolean	Determines whether a server object is defunct
PostEvent	Boolean	Adds an event to the end of the message queue of the user object
ReleaseAutomationNativePointer	Integer	Releases the pointer to the underlying OLE object
SetAutomationLocale	Integer	Sets the language locale to be used for automation programming on the object
SetAutomationPointer	Integer	Sets the automation pointer of an OLEObject object to the value of the automation pointer of another object
SetAutomationTimeout	Integer	Sets the number of milliseconds that a PowerBuilder client waits before canceling an OLE procedure call to the server
TriggerEvent	Integer	Sends an event to the user object and executes the script associated with the event
TypeOf	Object	Returns the type of the user object

Document get from Powerbuilder help

Thank you for watching.

Powerbuilder Documentation 2019

August 21, 2023

Was this article helpful?

Connection Information

OLEObject object – PB Docs 2019