Function

Summary

Prints the defined methods for an i-dispatch.

Package

com

Signature

print-i-dispatch-methods i-dispatch &optional arguments-p

Arguments

i-dispatch

An i-dispatch interface object.

arguments-p

A boolean.

Description

The function print-i-dispatch-methods prints the methods that are defined for the i-dispatch i-dispatch.

print-i-dispatch-methods tries to get the information about the methods of the i-dispatch and print them in a readable format. If arguments-p is nil then for each each method it prints its name, followed by the invocation type(s) inside curly brackets. Invocation types are:

"Method"

Invoked by invoke-dispatch-method.

"Get"

Invoked by invoke-dispatch-get-property.

"Put", "Putref"

Invoked by invoke-dispatch-put-property.

If arguments-p is true, print-i-dispatch-methods also prints the types of the arguments for each method. The type of each argument is shown as a plain string followed by the VT_constant name delimited by curly brackets. The type may be preceded by:

By reference

Means the argument has VT_BYREF. The argument in that is passed in Lisp should be the actual type. By reference argument values are returned as multiple values, following the return value of the method if it has one.

Array of

Means it got VT_ARRAY. The argument in Lisp should be an array.

Array of references

Means it got VT_ARRAY and VT_BYREF. The argument needs to be an array of the actual type.

The default value of arguments-p is nil.

Notes

1. print-i-dispatch-methods gives only partial information, and is therefore useful only for the simple methods where it is pretty obvious what the arguments are. If the arguments are not obvious, you will need to read the actual documentation.
2. The type Variant means any type, but note that the method may accept only specific types even if the argument is variant.

See also

get-i-dispatch-name
i-dispatch
invoke-dispatch-put-property
invoke-dispatch-get-property
invoke-dispatch-method
Calling Automation methods without a type library