This page describes Tcl® calls that manipulate AppleEvent sub-descriptors. For information on the associated AEGizmos calls, see Jens AlfkeÕs documentation.
tclAE::subdesc::dispose
Dispose of an AESubDesc.
tclAE::subdesc::dispose
theAESubDesc
None.
theAESubDesc is deleted and its hash key is removed
from the AESubDesc hash table.
Note: The underlying
AEDesc is not
disposed of. That would be Badª.
Note: This Tcl proc has no analogue in the
AEGizmos API. AESubDescs are not normally
allocated, so they don't need to be disposed of. This proc is
needed because in TclAE, AESubDescs are allocated on a
hash table.
tclAE::subdesc::fromDesc
Tcl wrapper for AEGizmosÕ
AEDescToSubDesc call.
tclAE::subdesc::fromDesc
theAEDesc
Hash key for new AESubDesc.
Create a new AESubDesc, referencing the
supplied AEDesc.
Your application is responsible for using the tclAE::subdesc::dispose function to
dispose of the resulting sub-descriptor record when you no longer need it.
tclAE::subdesc::getBasicType
Tcl wrapper for AEGizmosÕ
AEGetSubDescBasicType call.
tclAE::subdesc::getBasicType
theAESubDesc
Basic type of theAESubDesc.
This proc returns the same value as tclAE::subdesc::getType, with
one exception; if the sub-descriptor is a coerced record, the type returned
is 'reco'.
tclAE::subdesc::getData
Tcl wrapper for AEGizmos
AEGetSubDescData call.
tclAE::subdesc::getData
theAESubDesc
[asRawBinary]
The data from the
theAESubDesc.
The descriptor record referenced by theAESubDesc is
processed as by tclAE::getData.
tclAE::subdesc::getKey
Tcl wrapper for AEGizmosÕ
AEGetKeySubDesc call.
tclAE::subdesc::getKey
theAESubDesc
theAEKeyword
[inPlace]
Hash key for new AESubDesc.
The key record specified by theAEKeyword is
obtained from the AERecord referenced by
theAESubDesc.
Your application is responsible for using the tclAE::subdesc::dispose function to
dispose of the resulting sub-descriptor record when you no longer need it.
tclAE::subdesc::getKeyData
Convenience access to data of AEGetKeySubDesc.
tclAE::subdesc::getKeyData
theAESubDesc
theAEKeyword
[asRawBinary]
The data held
in the keyword-specified descriptor record of theAESubDesc.
The keyword-specified descriptor record specified by theAEKeyword is
obtained from the AERecord referenced by
theAESubDesc. The
resulting AEDesc is
processed as by tclAE::getData.
tclAE::subdesc::getNth
Tcl wrapper for AEGizmosÕ
AEGetNthSubDesc call.
tclAE::subdesc::getNth
theAESubDesc
index
[keyIfAnyPtr]
[inPlace]
Hash key for new AESubDesc.
The sub-descriptor record at position index is obtained from the
AEDescList
referenced by theAESubDesc.
Your application is responsible for using the tclAE::subdesc::dispose function to
dispose of the resulting sub-descriptor record when you no longer need it.
tclAE::subdesc::getNthData
Convenience access to data of AEGetNthSubDesc.
tclAE::subdesc::getNthData
theAESubDesc
index
[keyIfAnyPtr]
[asRawBinary]
The data from
the specified item of theAESubDesc.
The descriptor record at position index is obtained from the
AEDescList
referenced by theAESubDesc. The
resulting AEDesc is
processed as by tclAE::getData.
tclAE::subdesc::getType
Tcl wrapper for AEGizmosÕ
AEGetSubDescType call.
tclAE::subdesc::getType
theAESubDesc
DescType of
theAESubDesc.
This returns the descriptor type code of the sub-descriptor.
tclAE::subdesc::isListOrRecord
Tcl wrapper for AEGizmosÕ
AESubDescIsListOrRecord call.
tclAE::subdesc::isListOrRecord
theAESubDesc
True if basic type of theAESubDesc is
'list' or 'reco'.
tclAE::subdesc::listSubDescriptors
List the active AESubDesc hash keys.
tclAE::subdesc::listSubDescriptors
List of AESubDesc hash
keys.
tclAE::subdesc::toDesc
Tcl wrapper for AEGizmosÕ
AESubDescToDesc call.
tclAE::subdesc::toDesc
theAESubDesc
[desiredType]
Hash key for new AEDesc.
Copies a sub-descriptor into a brand new AEDesc. The resulting
descriptor will be coerced to desiredType (if
present); if you don't want any coercion, pass '****' as the
desiredType.
Your application is responsible for using the tclAE::disposeDesc function to
dispose of the resulting descriptor record when you no longer need it.
Copyright © 1999Ð2000 Jonathan E. Guyer
All rights reserved.