This page describes Tcl® calls that manipulate AppleEvent descriptors. For information on the associated ToolBox calls and data structures, see INSIDE MACINTOSH: Interapplication Communication.
tclAE::buildAEBuild call.
tclAE::build
AEGizmo
[descriptor parameters]*
Hash key for new AEDesc.
Build an AEDesc from an
AEGizmo string (plus
optional descriptor parameters).
Your application is responsible for using the tclAE::disposeDesc function to
dispose of the resulting descriptor record when you no longer need it.
Alpha users: This is not to be confused with Alpha's old (and
still existing) AEBuild call. Pete combined the functions of
AEBuild and AESend,
but it now makes sense to distinguish them.
tclAE::coerceData
Tcl wrapper for ToolBox AECoercePtr call.
tclAE::coerceData
typeCode
data
toType
Hash key for new AEDesc.
Create a new AEDesc,
casting data
from typeCode to toType. Unlike the ToolBox
call, the data is passed directly, rather than in a pointer.
Your application is responsible for using the tclAE::disposeDesc function to
dispose of the resulting descriptor record when you no longer need it.
tclAE::coerceDesc
Tcl wrapper for ToolBox AECoerceDesc call.
tclAE::coerceDesc
anyAEDesc
toType
Hash key for new AEDesc.
Create a new AEDesc,
casting the original AEDesc to toType.
If anyAEDesc is an
AEGizmo, it cannot take
'@' parameters.
Your application is responsible for using the tclAE::disposeDesc function to
dispose of the resulting descriptor record when you no longer need it.
tclAE::createDesc
Tcl wrapper for ToolBox AECreateDesc call.
tclAE::createDesc
typeCode
[data]
Hash key for new AEDesc.
Create a new AEDesc of
type typeCode with optional
data.
Your application is responsible for using the tclAE::disposeDesc function to
dispose of the resulting descriptor record when you no longer need it.
tclAE::disposeDesc
Tcl wrapper for ToolBox AEDisposeDesc call.
tclAE::disposeDesc
theAEDesc
None.
The specified AEDesc is
disposed of and its hash key is deleted.
tclAE::duplicateDesc
Tcl wrapper for ToolBox AEDuplicateDesc call.
tclAE::duplicateDesc
anyAEDesc
Hash key for duplicate AEDesc.
The descriptor record specified by anyAEDesc is duplicated and the
new AEDesc is entered
into the hash table.
Your application is responsible for using the tclAE::disposeDesc function to
dispose of the resulting descriptor record when you no longer need it.
tclAE::getData
Tcl read access for theAEDesc.dataHandle, including coercion.
tclAE::getData
theAEDesc
[desiredType]
[typeCodePtr]
theAEDesc
is cast to desiredType (if
supplied). Pass '????' in desiredType to force
the return of raw binary data.
tclAE::getDescType
Tcl read access for theAEDesc.descriptorType.
tclAE::getDescType
theAEDesc
tclAE::listDescriptors
List the active AEDesc
hash keys.
tclAE::listDescriptors
List of AEDesc hash keys.
The hash keys for the active descriptor records are compiled and returned in a Tcl list.
tclAE::print
Tcl wrapper for AEGizmos AEPrint call.
tclAE::print
anyAEDesc
AEGizmo string
representation of anyAEDesc.
anyAEDesc
is passed through AEGizmosÕ AEPrint.
Alpha note: This is
the form historically returned by the obsolete AEBuild call.
tclAE::replaceDescData
Tcl wrapper for Carbon AEReplaceDescData
call and/or Tcl write access for theAEDesc.typeCode and
theAEDesc.dataHandle.
tclAE::replaceDescData
theAEDesc
typeCode
data
None.
The data and
typeCode
in theAEDesc are
replaced.
tclAE::setDescType
Tcl write access for theAEDesc.descriptorType.
tclAE::setDescType
theAEDesc
toType
None.
The DescType of
theAEDesc
is set to toType.
tclAE::countItems
Tcl wrapper for ToolBox AECountItems (or AEGizmos
AECountSubDescItems) call.
tclAE::countItems
anyAEDescList
The number of items in anyAEDescList.
Count items in anyAEDescList.
anyAEDescList
cannot be an AEGizmo string.
tclAE::createList
Tcl wrapper for ToolBox AECreateList call.
tclAE::createList
[isRecord]
Hash key for new AEDescList.
If isRecord is present and true, an AERecord is created, otherwise
an AEDescList.
Your application is responsible for using the tclAE::disposeDesc function to
dispose of the resulting descriptor record when you no longer need it.
tclAE::deleteItem
Tcl wrapper for ToolBox AEDeleteItem call.
tclAE::deleteItem
theAEDescList
index
None.
Delete descriptor record at position index from theAEDescList. All
subesequent descriptor records will then move up one item.
tclAE::getNthData
Tcl emulator for ToolBox AEGetNthPtr call.
tclAE::getNthData
theAEDescList
index
[desiredType]
[keyIfAnyPtr]
[typeCodePtr]
The data from
the descriptor record at position index in theAEDescList.
The descriptor record specified by index is obtained from theAEDescList. The
resulting AEDesc is
then processed as by tclAE::getData.
tclAE::getNthDesc
Tcl wrapper for ToolBox AEGetNthDesc call.
tclAE::getNthDesc
theAEDescList
index
[desiredType]
[keyIfAnyPtr]
AEDesc hash key for the item descriptor.
The item record specified by index is obtained from
theAEDescList. The
resulting AEDesc is
optionally coerced to desiredType,
duplicated, and a new hash key is returned for it.
Your application is responsible for using the tclAE::disposeDesc function to
dispose of the resulting descriptor record when you no longer need it.
tclAE::getNthGizmo
Alternative Tcl wrapper for ToolBox AEGetNthDesc call.
tclAE::getNthGizmo
theAEDescList
index
[desiredType]
[keyIfAnyPtr]
AEGizmo string representation of the item descriptor.
The descriptor record specified by index is obtained from
theAEDescList. The
resulting AEDesc is
optionally coerced to desiredType, and then
passed through AEPrint.
tclAE::putData
Tcl emulator for ToolBox AEPutPtr call.
tclAE::putData
theAEDescList
index
typeCode
data
None.
The descriptor record specified by index in theAEDescList is
replaced with a new descriptor record composed from data cast to typeCode.
tclAE::putDesc
Tcl wrapper for ToolBox AEPutDesc
call.
tclAE::putDesc
theAEDescList
index
anyAEDesc
None.
The descriptor record specified by index in theAEDescList is
replaced with a copy of anyAEDesc.
tclAE::deleteKey
Tcl wrapper for ToolBox AEDeleteKeyDesc call.
tclAE::deleteKey
theAERecord
theAEKeyword
None.
Delete the keyword-specified descriptor record specified by theAEKeyword from theAERecord.
tclAE::getKeyData
Tcl emulator for ToolBox AEGetKeyPtr call.
tclAE::getKeyData
theAERecord
theAEKeyword
[desiredType]
[typeCodePtr]
The data from
the keyword-specified descriptor record from theAERecord.
The keyword-specified descriptor record specified by theAEKeyword is
obtained from theAERecord. The
resulting AEDesc is then
processed as by tclAE::getData.
tclAE::getKeyDesc
Tcl wrapper for ToolBox AEGetKeyDesc call.
tclAE::getKeyDesc
theAERecord
theAEKeyword
[desiredType]
New AEDesc.
The keyword-specified descriptor record specified by theAEKeyword is
obtained from theAERecord, optionally
coerced to desiredType,
duplicated, and a new hash key is returned for it.
Your application is responsible for using the tclAE::disposeDesc function to
dispose of the resulting descriptor record when you no longer need it.
tclAE::getKeyGizmo
Alternative Tcl wrapper for ToolBox AEGetKeyDesc call.
tclAE::getKeyGizmo
theAERecord
theAEKeyword
[desiredType]
AEGizmo string representation of the key descriptor.
The keyword-specified descriptor record specified by theAEKeyword is
obtained from theAERecord, optionally
coerced to desiredType, and then
passed through AEPrint.
tclAE::putKeyData
Tcl emulator for ToolBox AEPutKeyPtr call.
tclAE::putKeyData
theAERecord
theAEKeyword
typeCode
data
None.
The keyword-specified descriptor record specified by theAEKeyword in
theAERecord is replaced
with a new descriptor record composed from data cast to typeCode.
tclAE::putKeyDesc
Tcl wrapper for ToolBox AEPutKeyDesc call.
tclAE::putKeyDesc
theAERecord
theAEKeyword
anyAEDesc
None.
The keyword-specified descriptor record specified by theAEKeyword in
theAERecord is replaced
with a copy of anyAEDesc.
Copyright © 1999Ð2000 Jonathan E. Guyer. All rights reserved.
Last modified Monday, November 13, 2000 10:22:09 AM