4.12 The OLE-AUTOMATION module
get-id-of-name
Function
Summary
Returns the integer Dispatch ID (DISPID) for the dispatch method or property whose name (for the given locale) matches the given string name.
Signature
get-id-of-name disp-interface name #key locale undefined-ok? => disp-ID
Arguments
- disp-interface
- An instance of
<LPDISPATCH>. - name
- An instance of
<string>. - locale
- An instance of
<integer>. Default value:$LOCALE-USER-DEFAULT. - undefined-ok?
- An instance of
<boolean>. Default value:#f.
Values
- disp-ID
- An instance of
<integer>.
Description
Returns the integer Dispatch ID (DISPID) for the dispatch method or property whose name (for the given locale) matches the given string name. (The match is not case-sensitive.)
The disp-interface argument is an instance of <LPDISPATCH>.
This function works for dispatch methods or properties, but does not support mapping the names of the arguments of dispatch methods.
If name is not defined and undefined-ok? is true, the function returns the integer value $DISPID-UNKNOWN instead of signalling an error.