$com » History » Version 4
Per Amundsen, 08/11/2015 01:50 PM
| 1 | 1 | Per Amundsen | _Added in 1.9.4_ |
|---|---|---|---|
| 2 | |||
| 3 | 4 | Per Amundsen | *$com(name|N)* |
| 4 | 1 | Per Amundsen | |
| 5 | Returns name if connection is open, or name of Nth connection. N = 0 returns number of open connections. |
||
| 6 | |||
| 7 | *Parameters* |
||
| 8 | |||
| 9 | 4 | Per Amundsen | name|N - The connection name or the Nth connection. |
| 10 | 1 | Per Amundsen | |
| 11 | *Properties* |
||
| 12 | |||
| 13 | .progid - The object name. |
||
| 14 | .result - The value returned by the COM object member after the call |
||
| 15 | .error - The error code if any. |
||
| 16 | .errortext - The error text if any. |
||
| 17 | .argerr - TODO |
||
| 18 | .dispatch - [[$true]] if this is a dispatch pointer. |
||
| 19 | .unknown - [[$true]] if this is a unknown pointer. |
||
| 20 | |||
| 21 | *$com(name/N,varname)* |
||
| 22 | |||
| 23 | Returns value of the specified variable name. |
||
| 24 | |||
| 25 | *Parameters* |
||
| 26 | |||
| 27 | 3 | Per Amundsen | name/N - The connection name or the Nth connection. |
| 28 | 1 | Per Amundsen | varname - Name of the referenced variable. |
| 29 | |||
| 30 | *$com(name,member,method,type1,value1,...,typeN,valueN)* |
||
| 31 | |||
| 32 | This calls a member of an open COM connection with the specified method and parameters. |
||
| 33 | |||
| 34 | Returns: 1 = ok, 0 = fail. |
||
| 35 | |||
| 36 | *Parameters* |
||
| 37 | |||
| 38 | name - Connection name. |
||
| 39 | member - Member name. |
||
| 40 | method - Combination of the following values added together: |
||
| 41 | 2 | Per Amundsen | <pre> |
| 42 | 1 | Per Amundsen | 1 = DISPATCH_METHOD |
| 43 | 2 = DISPATCH_PROPERTYGET |
||
| 44 | 4 = DISPATCH_PROPERTYPUT |
||
| 45 | 8 = DISPATCH_PROPERTYPUTREF |
||
| 46 | 2 | Per Amundsen | </pre> |
| 47 | 1 | Per Amundsen | type - The variable type, can be: i1, i2, i4, ui1, ui2, ui4, int, uint, r4, r8, cy, date, decimal, bool, bstr, variant, dispatch, unknown, error. |
| 48 | 2 | Per Amundsen | <pre> |
| 49 | 1 | Per Amundsen | VB equivalents are: boolean, byte, currency, date, double, integer, long, single, string, variant. |
| 50 | To make a variable by reference, use * in the type name, eg. i1* |
||
| 51 | To assign a name to a variable for later reference after a call, append it to the type, eg. i1* varname |
||
| 52 | When using a variant you must also specify the variable type after it, eg. variant bool. |
||
| 53 | 2 | Per Amundsen | </pre> |
| 54 | 1 | Per Amundsen | value - The value assigned to the variable type. |