11de33d4ff
The ActiveX part of MysterX is gone. The `ffi/com' re-imeplemtnation provides only core COM support. The "mysssink" DLL is still needed, and its source is still in the tree, but it is downloaded in the same way as other pre-built DLLs. The DLL no longer needs to be registered with regsvr32.
168 lines
5.7 KiB
Racket
168 lines
5.7 KiB
Racket
#lang scribble/doc
|
|
@(require "common.rkt")
|
|
|
|
@title[#:tag "methprop"]{COM Methods and Properties}
|
|
|
|
MysterX allows scripting of most COM components from Racket. A COM
|
|
component can be scripted in MysterX if it supports OLE Automation
|
|
via the @tt{IDispatch} interface, and if it publishes type
|
|
information using the @tt{ITypeInfo} interface.
|
|
|
|
@defproc[(com-all-coclasses) (listof string?)]{
|
|
|
|
Returns a list of strings for all COM classes
|
|
registered on a system.}
|
|
|
|
@defproc[(com-all-controls) (listof string?)]{
|
|
|
|
Returns a list of strings for all COM classes
|
|
registered on a system that have the @racket["Control"]
|
|
subkey.}
|
|
|
|
@deftogether[(
|
|
@defproc[(cocreate-instance-from-coclass [coclass string?]
|
|
[where (or/c (one-of/c 'local 'remote) string?) 'local])
|
|
com-object?]
|
|
@defproc[(cci/coclass [coclass string?]
|
|
[where (or/c (one-of/c 'local 'remote) string?) 'local])
|
|
com-object?]
|
|
)]{
|
|
|
|
Returns an instance of @racket[coclass]. This is useful for COM
|
|
classes without a visual representation, or when a visual
|
|
representation is not needed.
|
|
|
|
The optional argument @racket[where] indicates a for running the
|
|
instance, and may be @racket['local], @racket['remote], or a string
|
|
indicating a machine name. See @secref[#:doc '(lib
|
|
"scribblings/foreign/foreign.scrbl") "remote"] for more
|
|
information.}
|
|
|
|
@deftogether[(
|
|
@defproc[(cocreate-instance-from-progid [progid string?]
|
|
[where (or/c (one-of/c 'local 'remote) string?) 'local])
|
|
com-object?]
|
|
@defproc[(cci/progid [progid string?]
|
|
[where (or/c (one-of/c 'local 'remote) string?) 'local])
|
|
com-object?]
|
|
)]{
|
|
|
|
Like @racket[cocreate-instance-from-coclass], but using a ProgID.}
|
|
|
|
|
|
@deftogether[(
|
|
@defproc[(com-get-active-object-from-coclass [coclass string?])
|
|
com-object?]
|
|
@defproc[(gao/coclass [coclass string?])
|
|
com-object?]
|
|
)]{
|
|
|
|
Like @racket[cocreate-instance-from-coclass], but gets an existing
|
|
active object (always local) instead of creating a new one.}
|
|
|
|
|
|
@defproc[(coclass [obj com-object?]) string?]{
|
|
|
|
Returns a string that is the name of the COM class instantiated by
|
|
@racket[obj], or raises an error if the COM class is not known.}
|
|
|
|
@defproc[(progid [obj com-object?]) string?]{
|
|
|
|
Returns a string that is the name of the ProgID instantiated by
|
|
@racket[obj], or raises an error if the COM class is not known.}
|
|
|
|
@defproc[(set-coclass! [obj com-object?] [coclass string?]) void?]{
|
|
|
|
Sets the COM class for @racket[obj] to @racket[coclass]. This is
|
|
useful when MysterX COM event-handling procedures can obtain only
|
|
ambiguous information about the object's COM class.}
|
|
|
|
@defproc[(set-coclass-from-progid! [obj com-object?] [progid string?]) void?]{
|
|
|
|
Like @racket[set-coclass!], but using a ProgID.}
|
|
|
|
@defproc[(com-methods [obj/type (or/c com-object? com-type?)])
|
|
(listof string?)]{
|
|
|
|
Returns a list of strings indicating the names of methods on
|
|
@racket[obj/type].}
|
|
|
|
@defproc[(com-method-type [obj/type (or/c com-object? com-type?)]
|
|
[method-name string?])
|
|
(listof symbol?)]{
|
|
|
|
Returns a list of symbols indicating the type of the specified
|
|
method in @racket[obj/type]. See @secref["com-types"] for
|
|
information on the symbols.}
|
|
|
|
@defproc[(com-invoke [obj com-object?] [method-name string?] [v any/c] ...)
|
|
any/c]{
|
|
|
|
Invokes @racket[method-name] on @racket[obj] with @racket[v]s as the
|
|
arguments. The special value @racket[com-omit] may be used for
|
|
optional arguments, which useful when values are supplied for
|
|
arguments after the omitted argument(s).}
|
|
|
|
@defproc[(com-get-properties [obj/type (or/c com-object? com-type?)])
|
|
(listof string?)]{
|
|
|
|
Returns a list of strings indicating the names of readable
|
|
properties in @racket[obj/type].}
|
|
|
|
@defproc[(com-get-property-type [obj/type (or/c com-object? com-type?)]
|
|
[property-name string?])
|
|
(listof symbol?)]{
|
|
|
|
Returns a list of symbols indicating the type of the specified
|
|
property in @racket[obj/type]. See @secref["com-types"] for
|
|
information on the symbols.}
|
|
|
|
@defproc[(com-get-property [obj com-object?] [property string?] ...+)
|
|
any/c]{
|
|
|
|
Returns the value of the final property by following the indicated
|
|
path of @racket[property]s, where each intermediate property is a
|
|
COM object.}
|
|
|
|
@defproc[(com-set-properties [obj/type (or/c com-object? com-type?)])
|
|
(listof string?)]{
|
|
|
|
Returns a list of strings indicating the names of writeable
|
|
properties in @racket[obj/type].}
|
|
|
|
@defproc[(com-set-property-type [obj/type (or/c com-object? com-type?)]
|
|
[property-name strig?])
|
|
(listof symbol?)]{
|
|
|
|
Returns a list of symbols indicating the type of the specified
|
|
property in @racket[obj/type]. See @secref["com-types"] for
|
|
information on the symbols.}
|
|
|
|
@defproc[(com-set-property! [obj com-object?]
|
|
[string? property] ...+
|
|
[v any/c])
|
|
void?]{
|
|
|
|
Sets the value of the final property in @racket[obj] to @racket[v]
|
|
by following the @racket[property]s, where the value of each
|
|
intermediate property is a COM object.}
|
|
|
|
@defproc[(com-help [obj/type (or/c com-object? com-type?)]
|
|
[topic string? ""])
|
|
void?]{
|
|
|
|
Starts the Window Help system with help about the COM object or COM
|
|
type. The optional @racket[topic] is typically a method or property
|
|
name.}
|
|
|
|
@defproc[(com-object-eq? [obj1 com-object?] [obj2 com-object?])
|
|
boolean?]{
|
|
|
|
Returns @racket[#t] if the two COM objects are the same,
|
|
@racket[#f] otherwise.}
|
|
|
|
@defproc[(com-object? [obj com-object?]) boolean?]{
|
|
|
|
Returns @racket[#t] if the argument is a COM object, @racket[#f]
|
|
otherwise.}
|