GetOrdinalObjectDescriptor

From Xojo Documentation
Jump to: navigation, search
Method


Returns an AppleEventObjectSpecifier that is within another AppleEventObjectSpecifier. The AppleEventObjectSpecifier is found by class and an ordinal key.


Syntax

result=GetOrdinalObjectDescriptor(DesiredClass, Object, OrdinalKey)

Part Type Description
result AppleEventObjectSpecifier The object that was found.
DesiredClass String Indicates the class of AppleEvent object you are looking for.
Object AppleEventObjectSpecifier The source object. Pass Nil to search at the application level.
OrdinalKey String The scope to use when searching.

Notes

The ordinal keys are:

Key Description
firs First
last Last
midd Middle
any Any
all All

Ordinal keys are four characters so the "any" and "all" keys have a space following them.


Examples

This example asks the Finder for a count of the currently running processes:

Dim a as AppleEvent
Dim i, count as Integer
a = New AppleEvent("core", "cnte", "com.apple.finder")
a.MacTypeParam("kocl") = "prcs"
a.ObjectSpecifierParam("----") = GetOrdinalObjectDescriptor("prcs", nil, "all ")
If a.Send then
count = Val(a.ReplyString)
End if


See Also

AppleEvent class; GetIndexedObjectDescriptor, GetNamedObjectDescriptor, GetPropertyObjectDescriptor, GetRangeObjectDescriptor, GetStringComparisonObjectDescriptor, GetTestObjectDescriptor functions.

Personal tools
Namespaces

Variants
Actions
Main
Content
Starting Out
Dig Deeper
More Help
Toolbox
About