com_load_typelib

(PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8)

com_load_typelib — タイプライブラリを読み込む

説明

com_load_typelib(string $typelib, bool $case_insensitive = true): bool

タイプライブラリを読み込んで定数をエンジン内に登録し、それらが define() を使用して定義されているかのように扱えるようにします。

あまり融通の利く方法ではありませんが、 com.typelib-file php.ini 設定を利用して定数の事前読み込みと登録をすませるほうがずっと効率的であることに注意しましょう。

com.autoregister-typelib を有効にすると、 PHP がインスタンス化した COM オブジェクトに関連付けられている定数を自動的に登録しようと試みます。これは COM オブジェクト自身の提供するインターフェイスに依存し、常に可能であるとは限りません。

パラメータ

typelib

typelib は、以下のいずれかの形式となります。

.tlb ファイル、あるいはタイプライブラリを含む実行モジュールのファイル名。
タイプライブラリの GUID の後にバージョン番号を続ける。たとえば {00000200-0000-0010-8000-00AA006D2EA4},2,0 のような形式。
タイプライブラリ名。たとえば Microsoft OLE DB ActiveX Data Objects 1.0 Library のような形式。

PHP は、この順序でタイプライブラリ名の解決を試みます。リストの下のほうにいくほど検索処理のコストが高くなります。タイプライブラリ名による検索は、一致するものが見つかるまでレジストリを物理的に列挙していくという方法をとっています。

case_insensitive

case_insensitive は、 define() 関数の $case_insensitive とは逆の動きをします。

戻り値

成功した場合に true を、失敗した場合に false を返します。

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 5 notes

down

tomas dot burba at softneta dot lt ¶

12 years ago

I had some problems with a third-party Word-controlling code that is somewhat similar to Richard's example. (Word 2007 SP1, XP SP2.) Rewrote some parts according to that example, no luck. Error messages from Word were crazy:

"Bad parameter" -- it didn't like wdGoToBookmark but was ok with its numeric equivalent -1;

"Call to undefined method variant::SaveAs()" -- the same with Save() that was suitable in my case, so no options were remaining.

But then I ran the example via php.exe in the command line, and it worked! Eventually it turned out that Apache service must be run as some real user instead of SYSTEM.

down

RQuadling at GMail dot com ¶

16 years ago

Some libraries load other libraries as part of their functionality. For example Crystal Reports Object Factory uses the CreateObject() method to create an instance of a Crystal Design RunTime Application. If you want to use constants defined in the newly loaded library, you will need to manually register the library - even with com.autoregister_typelib set to true.



<?php

echo 'com.autoregister_typelib = ', ini_get('com.autoregister_typelib'), PHP_EOL;



$o_CrObjectFactory = New COM('CrystalReports11.ObjectFactory.1');



$o_CrApplication = $o_CrObjectFactory->CreateObject("CrystalDesignRunTime.Application");



echo 'Will not be defined : ', crOpenReportByDefault, PHP_EOL;



com_load_typelib('CrystalDesignRunTime.Application');



echo 'Will now be defined : ', crOpenReportByDefault, PHP_EOL;

?>



outputs ...



com.autoregister_typelib = 1

Will not be defined :

Notice: Use of undefined constant crOpenReportByDefault - assumed 'crOpenReportByDefault' in C:\refl.php on line 8

crOpenReportByDefault

Will now be defined : 0

down

Anonymous ¶

20 years ago

In case any of you were wondering what com_load_typelib actually DOES, I have found that it loads constants\enums that the COM obeject has defined.  The example below is using the Nero COM object (from Nero Burning rom, version 6+).  The Nero object defines a bunch of constants, but they can not be used as PHP constants unless you use the mentioned function.  So the example below will work just fine:

<?php
$aNero = new COM("Nero.Nero") or die ("Nero didn't load, too bad");
com_load_typelib("Nero.Nero");
$aNero->GetDrives(NERO_MEDIA_CD);
?>

But this one will not, since PHP will return a message saying that the constant is undefined:

<?php
$aNero = new COM("Nero.Nero") or die ("Nero didn't load, too bad");
$aNero->GetDrives(NERO_MEDIA_CD);
?>

This one took me a while to figure out, hope it helps.  

Also, check out http://www.php.net/manual/en/faq.com.php to find out how to get COM events working in PHP.

down

ojpp at webdevfm dot com ¶

20 years ago

Hello PHP community, I want to help in a problem I found in this COM built-in function: com_load_typelib(), when I executed it in order to open a COM Server process (for example: Word, Excel, etc.) I was in trouble to release the object from memory, I figured it out, this is the solution:

Change a configuration in the php.ini:

; autoregister constants of a components typlib on com_load()
com.autoregister_typelib = true

When com.autoregister_typelib directive is true, PHP parser manage the COM server type library, I hope it helps.

down

richard dot quadling at carval dot co dot uk ¶

21 years ago

<?php
// Some servers may have an auto timeout, so take as long as you want.
set_time_limit(0);

// Show all errors, warnings and notices whilst developing.
error_reporting(E_ALL);

// Used as a placeholder in certain COM functions where no parameter is required.
$empty = new VARIANT();

// Load the appropriate type library.
com_load_typelib('Word.Application');

// Create an object to use.
$word = new COM('word.application') or die('Unable to load Word');
print "Loaded Word, version {$word->Version}\n";

// Open a new document with bookmarks of YourName and YourAge.
$word->Documents->Open('C:/Unfilled.DOC');

// Fill in the information from the form.
$word->Selection->GoTo(wdGoToBookmark,$empty,$empty,'YourName'); // Note use of wdGoToBookmark, from the typelibrary and the use of $empty.
$word->Selection->TypeText($_GET['YourName']);

$word->Selection->GoTo(wdGoToBookmark,$empty,$empty,'YourAge');
$word->Selection->TypeText($_GET['YourAge']);

// Save it, close word and finish.
$word->Documents[1]->SaveAs("C:/{$_GET['YourName']}.doc");
$word->Quit();
$word->Release();
$word = null;
print "Word closed.\n";
?>

The example document is ...

Hello [Bookmark of YourName], you are [Bookmark of YourAge] years old.

and it would be called ...

word.php?YourName=Richard%20Quadling&YourAge=35

Regards,

Richard.

＋add a note