Function

Summary

Attaches a sink to the active component in an ole-control-pane.

Package

capi

Signature

attach-simple-sink invoke-callback pane interface-name &key sink-class => sink

Arguments

invoke-callback

A function designator.

pane

An ole-control-pane.

interface-name

A refguid or the symbol :default .

sink-class

A symbol naming a class.

Values

sink

The sink object.

Description

The function attach-simple-sink make a sink object and attaches it to the active component in pane .

When an event callback is triggered for the source interface named by interface-name, the sink object will call the invoke-callback with four arguments: the pane (see sink-class below), the source method name as a string, the source method type (either :method , :get or :put ) and a vector of the remaining callback arguments.

interface-name is either a string naming a source interface that the component in pane supports or :default to connect to the default source interface.

sink-class can be used to control the class of the sink object. This defaults to ole-control-pane-simple-sink, but can be a subclass of this class to allow the first argument of the invoke-callback to be chosen by a method on the generic function com:simple-i-dispatch-callback-object .

Attached sinks are automatically disconnected when the object is closed or can be manually disconnected by calling detach-simple-sink.

Note: this function is implemented only in LispWorks for Windows. Load the functionality by (require "embed") .

See also

detach-simple-sink
ole-control-pane
ole-control-pane-simple-sink