Legacy Document

Important: The information in this document is obsolete and should not be used for new development.

Chapter 8 - Dictionary Manager / Dictionary Manager Reference

Routines / Modifying a Dictionary

DeleteRecordFromDictionary
The DeleteRecordFromDictionary function removes a record from the specified dictionary file.
FUNCTION DeleteRecordFromDictionary
                     (dictionaryReference: LongInt;
                        key: Str255): OSErr;
dictionaryReference
A number that specifies a particular open dictionary.
key
A Pascal string that denotes the key of the record to be deleted.

DESCRIPTION
If DeleteRecordFromDictionary returns any of the errors listed in "Result Codes," it did not remove any records from the specified dictionary.

SPECIAL CONSIDERATIONS
DeleteRecordFromDictionary may move memory; your application should not call this function at interrupt time.

RESULT CODES
In addition to the standard File Manager, Memory Manager, and Resource Manager errors, DeleteRecordFromDictionary may return any of the following result codes.
noErr 0 No error
notBTree -410 File is not a dictionary
btRecNotFnd -415 Record cannot be found
btKeyLenErr -416 Key length too great or equal to zero

SEE ALSO
File Manager error codes are described in Inside Macintosh: Files. Memory Manager error codes are described in Inside Macintosh: Memory. Resource Manager error codes are described in Inside Macintosh: More Macintosh Toolbox.

Shop the Apple Online Store (1-800-MY-APPLE), visit an Apple Retail Store, or find a reseller.

noErr	0	No error
notBTree	-410	File is not a dictionary
btRecNotFnd	-415	Record cannot be found
btKeyLenErr	-416	Key length too great or equal to zero