com_get_active_object
(PHP 5, PHP 7)
com_get_active_object — Returns a handle to an already running instance of a COM object
Description
com_get_active_object() is similar to creating a new instance of a COM object, except that it will only return an object to your script if the object is already running. OLE applications use something known as the "Running Object Table" to allow well-known applications to be launched only once; this function exposes the COM library function GetActiveObject() to get a handle on a running instance.
Parameters
-
progid -
progidmust be either the ProgID or CLSID for the object that you want to access (for example Word.Application). -
code_page -
Acts in precisely the same way that it does for the COM class.
Return Values
If the requested object is running, it will be returned to your script just like any other COM object.
Errors/Exceptions
There are a variety of reasons why this function might fail, the most
common being that the object is not already running. In that situation,
the exception error code will be MK_E_UNAVAILABLE;
you can use the getCode method of the exception object
to check the exception code.
Notes
Using com_get_active_object() in a web server context is not always a smart idea. Most COM/OLE applications are not designed to handle more than one client concurrently, even (or especially!) Microsoft Office. You should read » Considerations for Server-Side Automation of Office for more information on the general issues involved.
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-com-get-active-object.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
