invoke-dispatch-put-property Function

Summary

Call a dispatch property setter method from an interface pointer.

Package

com

Signature

invoke-dispatch-put-property dispinterface-ptr name &rest args => value*

Arguments

Values

Description

The function invoke-dispatch-put-property is used to invoke an Automation property setter method from Lisp without needing to compile a type library as part of the application. This is similar to using:

Dim var as Object
var.Prop = 2

in Microsoft Visual Basic and contrasts with the macro call-dispatch-put-property which requires a type library to be compiled.

dispinterface-ptr should be a COM interface pointer for the i-dispatch interface.

The appropriate Automation method, chosen using name, which is either a string naming the method or the integer id of the method.

args are converted to Automation values and are passed as the method's in and in-out parameters in the order in which they appear. The new value of the property should be the last argument. The returned values in value* consist of the primary value of the method (if not void) and the values of any out or in-out parameters. See 3.3.3 Data conversion when calling Automation methods for more details.

Examples

For example, in order to set the Width property of an interface pointer in the variable doc:

(invoke-dispatch-put-property doc "Width" 10)

See also

invoke-dispatch-method
invoke-dispatch-get-property
call-dispatch-put-property