Home > PHP > Function > COM > com_get_active_object()

com_get_active_object()

com_get_active_object - Returns a handle to an already running instance of a COM object

Syntax

variant com_get_active_object (string $progid, int $code_page)

Arguments

  • progid - progid must 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 COMclass.

Description

com_get_active_object() is similar to creating a new instance of a COMobject, 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.

Version

PHP 5

Return value

If the requested object is running, it will be returned to your script just like any other COM object.