Dictionary Manager Interfaces. More...

#include <MacTypes.h>
#include <Files.h>
#include <AERegistry.h>
#include <CodeFragments.h>
#include <MacErrors.h>

Go to the source code of this file.

Data Structures
struct	DCMDictionaryHeader

struct	DictionaryInformation

struct	DictionaryAttributeTable

Macros
#define	kDCMInvalidObjectID ((DCMObjectID)kInvalidID)

#define	kDCMInvalidObjectRef ((DCMObjectRef)kInvalidID)

#define	NewDCMProgressFilterUPP(userRoutine)

#define	DisposeDCMProgressFilterUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	InvokeDCMProgressFilterUPP(determinateProcess, percentageComplete, callbackUD, userUPP)

#define	NewDCMProgressFilterProc(userRoutine) NewDCMProgressFilterUPP(userRoutine)

#define	CallDCMProgressFilterProc(userRoutine, determinateProcess, percentageComplete, callbackUD)

#define	kAppleJapaneseDefaultAccessMethodName "\pDAM:Apple Backward Trie Access Method"

Typedefs
typedef OptionBits	DCMFieldAttributes

typedef OSType	DCMFindMethod

typedef OptionBits	DCMAccessMethodFeature

typedef UInt32	DCMUniqueID

typedef struct OpaqueDCMObjectID *	DCMObjectID

typedef DCMObjectID	DCMAccessMethodID

typedef DCMObjectID	DCMDictionaryID

typedef struct OpaqueDCMObjectRef *	DCMObjectRef

typedef DCMObjectRef	DCMDictionaryRef

typedef DCMObjectRef	DCMDictionaryStreamRef

typedef struct OpaqueDCMObjectIterator *	DCMObjectIterator

typedef DCMObjectIterator	DCMAccessMethodIterator

typedef DCMObjectIterator	DCMDictionaryIterator

typedef struct OpaqueDCMFoundRecordIterator *	DCMFoundRecordIterator

typedef DescType	DCMFieldTag

typedef DescType	DCMFieldType

typedef struct DCMDictionaryHeader	DCMDictionaryHeader

typedef UInt16	percentageComplete

typedef UInt16 UInt32	callbackUD

typedef short	DictionaryDataInsertMode

typedef SInt8	DictionaryEntryAttribute

typedef struct DictionaryInformation	DictionaryInformation

typedef struct DictionaryAttributeTable	DictionaryAttributeTable

typedef DictionaryAttributeTable *	DictionaryAttributeTablePtr

Enumerations
enum	{ kDictionaryFileType = FOUR_CHAR_CODE('dict') , kDCMDictionaryHeaderSignature = FOUR_CHAR_CODE('dict') , kDCMDictionaryHeaderVersion = 2 }

enum	{ kDCMAnyFieldTag = typeWildCard , kDCMAnyFieldType = typeWildCard }

enum	{ keyDCMFieldTag = FOUR_CHAR_CODE('ftag') , keyDCMFieldType = FOUR_CHAR_CODE('ftyp') , keyDCMMaxRecordSize = FOUR_CHAR_CODE('mrsz') , keyDCMFieldAttributes = FOUR_CHAR_CODE('fatr') , keyDCMFieldDefaultData = FOUR_CHAR_CODE('fdef') , keyDCMFieldName = FOUR_CHAR_CODE('fnam') , keyDCMFieldFindMethods }

enum	{ typeDCMFieldAttributes = FOUR_CHAR_CODE('fatr') , typeDCMFindMethod = FOUR_CHAR_CODE('fmth') }

enum	{ kDCMIndexedFieldMask = 0x00000001 , kDCMRequiredFieldMask = 0x00000002 , kDCMIdentifyFieldMask = 0x00000004 , kDCMFixedSizeFieldMask = 0x00000008 , kDCMHiddenFieldMask = (long)0x80000000 }

enum	{ pDCMAccessMethod = FOUR_CHAR_CODE('amtd') , pDCMPermission = FOUR_CHAR_CODE('perm') , pDCMListing = FOUR_CHAR_CODE('list') , pDCMMaintenance = FOUR_CHAR_CODE('mtnc') , pDCMLocale = FOUR_CHAR_CODE('locl') , pDCMClass = pClass , pDCMCopyright = FOUR_CHAR_CODE('info') }

enum	{ kDCMReadOnlyDictionary = 0 , kDCMReadWriteDictionary = 1 }

enum	{ kDCMAllowListing = 0 , kDCMProhibitListing = 1 }

enum	{ kDCMUserDictionaryClass = 0 , kDCMSpecificDictionaryClass = 1 , kDCMBasicDictionaryClass = 2 }

enum	{ kDCMFindMethodExactMatch = kAEEquals , kDCMFindMethodBeginningMatch = kAEBeginsWith , kDCMFindMethodContainsMatch = kAEContains , kDCMFindMethodEndingMatch = kAEEndsWith , kDCMFindMethodForwardTrie , kDCMFindMethodBackwardTrie }

enum	{ kDCMCanUseFileDictionaryMask = 0x00000001 , kDCMCanUseMemoryDictionaryMask = 0x00000002 , kDCMCanStreamDictionaryMask = 0x00000004 , kDCMCanHaveMultipleIndexMask = 0x00000008 , kDCMCanModifyDictionaryMask = 0x00000010 , kDCMCanCreateDictionaryMask = 0x00000020 , kDCMCanAddDictionaryFieldMask = 0x00000040 , kDCMCanUseTransactionMask = 0x00000080 }

enum	{ uppDCMProgressFilterProcInfo = 0x00000E50 }

enum	{ kMaxYomiLengthInAppleJapaneseDictionary = 40 , kMaxKanjiLengthInAppleJapaneseDictionary = 64 }

enum	{ kDCMJapaneseYomiTag = FOUR_CHAR_CODE('yomi') , kDCMJapaneseHyokiTag = FOUR_CHAR_CODE('hyok') , kDCMJapaneseHinshiTag = FOUR_CHAR_CODE('hins') , kDCMJapaneseWeightTag = FOUR_CHAR_CODE('hind') , kDCMJapanesePhoneticTag = FOUR_CHAR_CODE('hton') , kDCMJapaneseAccentTag = FOUR_CHAR_CODE('acnt') , kDCMJapaneseOnKunReadingTag = FOUR_CHAR_CODE('OnKn') , kDCMJapaneseFukugouInfoTag = FOUR_CHAR_CODE('fuku') }

enum	{ kDCMJapaneseYomiType = typeUnicodeText , kDCMJapaneseHyokiType = typeUnicodeText , kDCMJapaneseHinshiType = FOUR_CHAR_CODE('hins') , kDCMJapaneseWeightType = typeShortInteger , kDCMJapanesePhoneticType = typeUnicodeText , kDCMJapaneseAccentType = FOUR_CHAR_CODE('byte') , kDCMJapaneseOnKunReadingType = typeUnicodeText , kDCMJapaneseFukugouInfoType = FOUR_CHAR_CODE('fuku') }

enum	{ kInsert = 0 , kReplace = 1 , kInsertOrReplace = 2 }

enum	{ kIsCaseSensitive = 0x10 , kIsNotDiacriticalSensitive = 0x20 }

enum	{ kNoun = -1 , kVerb = -2 , kAdjective = -3 , kAdverb = -4 }

Functions
typedef	CALLBACK_API (Boolean, DCMProgressFilterProcPtr)(Boolean determinateProcess

typedef	STACK_UPP_TYPE (DCMProgressFilterProcPtr) DCMProgressFilterUPP

DCMProgressFilterUPP	NewDCMProgressFilterUPP (DCMProgressFilterProcPtr userRoutine)

void	DisposeDCMProgressFilterUPP (DCMProgressFilterUPP userUPP)

Boolean	InvokeDCMProgressFilterUPP (Boolean determinateProcess, UInt16 percentageComplete, UInt32 callbackUD, DCMProgressFilterUPP userUPP)

UInt32	DCMLibraryVersion (void)

OSStatus	DCMNewDictionary (DCMAccessMethodID accessMethodID, const FSSpec newDictionaryFile, ScriptCode scriptTag, const AEDesc listOfFieldInfoRecords, Boolean invisible, ItemCount recordCapacity, DCMDictionaryID *newDictionary)

OSStatus	DCMDeriveNewDictionary (DCMDictionaryID srcDictionary, const FSSpec newDictionaryFile, ScriptCode scriptTag, Boolean invisible, ItemCount recordCapacity, DCMDictionaryID newDictionary)

OSStatus	DCMDeleteDictionary (DCMDictionaryID dictionaryID)

OSStatus	DCMRegisterDictionaryFile (const FSSpec dictionaryFile, DCMDictionaryID dictionaryID)

OSStatus	DCMUnregisterDictionary (DCMDictionaryID dictionaryID)

OSStatus	DCMOpenDictionary (DCMDictionaryID dictionaryID, ByteCount protectKeySize, ConstLogicalAddress protectKey, DCMDictionaryRef *dictionaryRef)

OSStatus	DCMCloseDictionary (DCMDictionaryRef dictionaryRef)

OSStatus	DCMGetDictionaryWriteAccess (DCMDictionaryRef dictionaryRef, Duration timeOutDuration)

OSStatus	DCMReleaseDictionaryWriteAccess (DCMDictionaryRef dictionaryRef, Boolean commitTransaction)

OSStatus	DCMFindRecords (DCMDictionaryRef dictionaryRef, DCMFieldTag keyFieldTag, ByteCount keySize, ConstLogicalAddress keyData, DCMFindMethod findMethod, ItemCount preFetchedDataNum, DCMFieldTag preFetchedData[], ItemCount skipCount, ItemCount maxRecordCount, DCMFoundRecordIterator *recordIterator)

ItemCount	DCMCountRecordIterator (DCMFoundRecordIterator recordIterator)

OSStatus	DCMIterateFoundRecord (DCMFoundRecordIterator recordIterator, ByteCount maxKeySize, ByteCount actualKeySize, LogicalAddress keyData, DCMUniqueID uniqueID, AEDesc *dataList)

OSStatus	DCMDisposeRecordIterator (DCMFoundRecordIterator recordIterator)

OSStatus	DCMCountRecord (DCMDictionaryID dictionaryID, ItemCount *count)

OSStatus	DCMGetRecordSequenceNumber (DCMDictionaryRef dictionaryRef, DCMFieldTag keyFieldTag, ByteCount keySize, ConstLogicalAddress keyData, DCMUniqueID uniqueID, ItemCount *sequenceNum)

OSStatus	DCMGetNthRecord (DCMDictionaryRef dictionaryRef, DCMFieldTag keyFieldTag, ItemCount serialNum, ByteCount maxKeySize, ByteCount keySize, LogicalAddress keyData, DCMUniqueID uniqueID)

OSStatus	DCMGetNextRecord (DCMDictionaryRef dictionaryRef, DCMFieldTag keyFieldTag, ByteCount keySize, ConstLogicalAddress keyData, DCMUniqueID uniqueID, ByteCount maxKeySize, ByteCount nextKeySize, LogicalAddress nextKeyData, DCMUniqueID nextUniqueID)

OSStatus	DCMGetPrevRecord (DCMDictionaryRef dictionaryRef, DCMFieldTag keyFieldTag, ByteCount keySize, ConstLogicalAddress keyData, DCMUniqueID uniqueID, ByteCount maxKeySize, ByteCount prevKeySize, LogicalAddress prevKeyData, DCMUniqueID prevUniqueID)

OSStatus	DCMGetFieldData (DCMDictionaryRef dictionaryRef, DCMFieldTag keyFieldTag, ByteCount keySize, ConstLogicalAddress keyData, DCMUniqueID uniqueID, ItemCount numOfData, const DCMFieldTag dataTag[], AEDesc *dataList)

OSStatus	DCMSetFieldData (DCMDictionaryRef dictionaryRef, DCMFieldTag keyFieldTag, ByteCount keySize, ConstLogicalAddress keyData, DCMUniqueID uniqueID, const AEDesc *dataList)

OSStatus	DCMAddRecord (DCMDictionaryRef dictionaryRef, DCMFieldTag keyFieldTag, ByteCount keySize, ConstLogicalAddress keyData, Boolean checkOnly, const AEDesc dataList, DCMUniqueID newUniqueID)

OSStatus	DCMDeleteRecord (DCMDictionaryRef dictionaryRef, DCMFieldTag keyFieldTag, ByteCount keySize, ConstLogicalAddress keyData, DCMUniqueID uniqueID)

OSStatus	DCMReorganizeDictionary (DCMDictionaryID dictionaryID, ItemCount extraCapacity, DCMProgressFilterUPP progressProc, UInt32 userData)

OSStatus	DCMCompactDictionary (DCMDictionaryID dictionaryID, DCMProgressFilterUPP progressProc, UInt32 userData)

OSStatus	DCMGetFileFromDictionaryID (DCMDictionaryID dictionaryID, FSSpec *fileRef)

OSStatus	DCMGetDictionaryIDFromFile (const FSSpec fileRef, DCMDictionaryID dictionaryID)

DCMDictionaryID	DCMGetDictionaryIDFromRef (DCMDictionaryRef dictionaryRef)

OSStatus	DCMGetDictionaryFieldInfo (DCMDictionaryID dictionaryID, DCMFieldTag fieldTag, AEDesc *fieldInfoRecord)

OSStatus	DCMGetDictionaryProperty (DCMDictionaryID dictionaryID, DCMFieldTag propertyTag, ByteCount maxPropertySize, ByteCount *actualSize, LogicalAddress propertyValue)

OSStatus	DCMSetDictionaryProperty (DCMDictionaryID dictionaryID, DCMFieldTag propertyTag, ByteCount propertySize, ConstLogicalAddress propertyValue)

OSStatus	DCMGetDictionaryPropertyList (DCMDictionaryID dictionaryID, ItemCount maxPropertyNum, ItemCount *numProperties, DCMFieldTag propertyTag[])

OSStatus	DCMCreateDictionaryIterator (DCMDictionaryIterator *dictionaryIterator)

OSStatus	DCMCreateAccessMethodIterator (DCMAccessMethodIterator *accessMethodIterator)

ItemCount	DCMCountObjectIterator (DCMObjectIterator iterator)

OSStatus	DCMIterateObject (DCMObjectIterator iterator, DCMObjectID *objectID)

OSStatus	DCMResetObjectIterator (DCMObjectIterator iterator)

OSStatus	DCMDisposeObjectIterator (DCMObjectIterator iterator)

OSStatus	DCMGetAccessMethodIDFromName (ConstStr63Param accessMethodName, DCMAccessMethodID *accessMethodID)

OSStatus	DCMCreateFieldInfoRecord (DescType fieldTag, DescType fieldType, ByteCount maxRecordSize, DCMFieldAttributes fieldAttributes, AEDesc fieldDefaultData, ItemCount numberOfFindMethods, DCMFindMethod findMethods[], AEDesc fieldInfoRecord)

OSStatus	DCMGetFieldTagAndType (const AEDesc fieldInfoRecord, DCMFieldTag fieldTag, DCMFieldType *fieldType)

OSStatus	DCMGetFieldMaxRecordSize (const AEDesc fieldInfoRecord, ByteCount maxRecordSize)

OSStatus	DCMGetFieldAttributes (const AEDesc fieldInfoRecord, DCMFieldAttributes attributes)

OSStatus	DCMGetFieldDefaultData (const AEDesc fieldInfoRecord, DescType desiredType, AEDesc fieldDefaultData)

OSStatus	DCMGetFieldFindMethods (const AEDesc fieldInfoRecord, ItemCount findMethodsArrayMaxSize, DCMFindMethod findMethods[], ItemCount actualNumberOfFindMethods)

OSErr	InitializeDictionary (const FSSpec *theFsspecPtr, SInt16 maximumKeyLength, SInt8 keyAttributes, ScriptCode script)

OSErr	OpenDictionary (const FSSpec theFsspecPtr, SInt8 accessPermission, SInt32 dictionaryReference)

OSErr	CloseDictionary (SInt32 dictionaryReference)

OSErr	InsertRecordToDictionary (SInt32 dictionaryReference, ConstStr255Param key, Handle recordDataHandle, DictionaryDataInsertMode whichMode)

OSErr	DeleteRecordFromDictionary (SInt32 dictionaryReference, ConstStr255Param key)

OSErr	FindRecordInDictionary (SInt32 dictionaryReference, ConstStr255Param key, DictionaryAttributeTablePtr requestedAttributeTablePointer, Handle recordDataHandle)

OSErr	FindRecordByIndexInDictionary (SInt32 dictionaryReference, SInt32 recordIndex, DictionaryAttributeTablePtr requestedAttributeTablePointer, Str255 recordKey, Handle recordDataHandle)

OSErr	GetDictionaryInformation (SInt32 dictionaryReference, DictionaryInformation *theDictionaryInformation)

OSErr	CompactDictionary (SInt32 dictionaryReference)

Detailed Description

Dictionary Manager Interfaces.

Introduced In: System 7

Avaliable From: Universal Interfaces 3.4.1

Copyright: © 1992-2001 by Apple Computer, Inc., all rights reserved.

For bug reports, consult the following page on the World Wide Web:

http://developer.apple.com/bugreporter/

Macro Definition Documentation

◆ CallDCMProgressFilterProc

#define CallDCMProgressFilterProc	(	userRoutine,
		determinateProcess,
		percentageComplete,
		callbackUD
	)

Value:

InvokeDCMProgressFilterUPP(determinateProcess, percentageComplete, \

callbackUD, userRoutine)

InvokeDCMProgressFilterUPP

Boolean InvokeDCMProgressFilterUPP(Boolean determinateProcess, UInt16 percentageComplete, UInt32 callbackUD, DCMProgressFilterUPP userUPP)

◆ InvokeDCMProgressFilterUPP

#define InvokeDCMProgressFilterUPP	(	determinateProcess,
		percentageComplete,
		callbackUD,
		userUPP
	)

Value:

    (Boolean) CALL_THREE_PARAMETER_UPP((userUPP), uppDCMProgressFilterProcInfo, \
                                       (determinateProcess),                    \
                                       (percentageComplete), (callbackUD))

◆ kAppleJapaneseDefaultAccessMethodName

#define kAppleJapaneseDefaultAccessMethodName "\pDAM:Apple Backward Trie Access Method"

Check Dictionary Manager availability

Definitions for Japanese Analysis Module

Default dictionary access method for Japanese analysis

◆ NewDCMProgressFilterUPP

#define NewDCMProgressFilterUPP ( userRoutine )

Value:

    (DCMProgressFilterUPP) NewRoutineDescriptor((ProcPtr)(userRoutine),       \
                                                uppDCMProgressFilterProcInfo, \
                                                GetCurrentArchitecture())

Typedef Documentation

◆ DCMFieldTag

typedef DescType DCMFieldTag

Field specification declarations

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Modern Dictionary Manager

Dictionary information

◆ anonymous enum

anonymous enum

Contents of a Field Info Record (an AERecord)

◆ anonymous enum

anonymous enum

Special types for fields of a Field Info Record

◆ anonymous enum

anonymous enum

Field attributes

◆ anonymous enum

anonymous enum

Standard dictionary properties

◆ anonymous enum

anonymous enum

pDCMPermission property constants

◆ anonymous enum

anonymous enum

pDCMListing property constants

◆ anonymous enum

anonymous enum

pDCMClass property constants

◆ anonymous enum

anonymous enum

Standard search method

◆ anonymous enum

anonymous enum

AccessMethod features

◆ anonymous enum

anonymous enum

Data length limitations of Apple Japanese dictionaries

◆ anonymous enum

anonymous enum

Defined field tags of Apple Japanese dictionary

◆ anonymous enum

anonymous enum

System 7 Dictionary Manager

Function Documentation

◆ CALLBACK_API()

typedef CALLBACK_API	(	Boolean	,
		DCMProgressFilterProcPtr
	)

Callback routines

◆ CloseDictionary()

OSErr CloseDictionary ( SInt32 dictionaryReference )

CloseDictionary()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ CompactDictionary()

OSErr CompactDictionary ( SInt32 dictionaryReference )

CompactDictionary()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ DCMAddRecord()

OSStatus DCMAddRecord	(	DCMDictionaryRef	dictionaryRef,
		DCMFieldTag	keyFieldTag,
		ByteCount	keySize,
		ConstLogicalAddress	keyData,
		Boolean	checkOnly,
		const AEDesc *	dataList,
		DCMUniqueID *	newUniqueID
	)

Add record DCMAddRecord()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMCloseDictionary()

OSStatus DCMCloseDictionary ( DCMDictionaryRef dictionaryRef )

DCMCloseDictionary()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMCompactDictionary()

OSStatus DCMCompactDictionary	(	DCMDictionaryID	dictionaryID,
		DCMProgressFilterUPP	progressProc,
		UInt32	userData
	)

DCMCompactDictionary()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMCountObjectIterator()

ItemCount DCMCountObjectIterator ( DCMObjectIterator iterator )

Iterator Operation DCMCountObjectIterator()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMCountRecord()

OSStatus DCMCountRecord	(	DCMDictionaryID	dictionaryID,
		ItemCount *	count
	)

Dump dictionary DCMCountRecord()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMCountRecordIterator()

ItemCount DCMCountRecordIterator ( DCMFoundRecordIterator recordIterator )

DCMCountRecordIterator()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMCreateAccessMethodIterator()

OSStatus DCMCreateAccessMethodIterator ( DCMAccessMethodIterator * accessMethodIterator )

Search AccessMethod DCMCreateAccessMethodIterator()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMCreateDictionaryIterator()

OSStatus DCMCreateDictionaryIterator ( DCMDictionaryIterator * dictionaryIterator )

Seaarch dictionary DCMCreateDictionaryIterator()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMCreateFieldInfoRecord()

OSStatus DCMCreateFieldInfoRecord	(	DescType	fieldTag,
		DescType	fieldType,
		ByteCount	maxRecordSize,
		DCMFieldAttributes	fieldAttributes,
		AEDesc *	fieldDefaultData,
		ItemCount	numberOfFindMethods,
		DCMFindMethod	findMethods[],
		AEDesc *	fieldInfoRecord
	)

Field Info Record routines DCMCreateFieldInfoRecord()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMDeleteDictionary()

OSStatus DCMDeleteDictionary ( DCMDictionaryID dictionaryID )

DCMDeleteDictionary()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMDeleteRecord()

OSStatus DCMDeleteRecord	(	DCMDictionaryRef	dictionaryRef,
		DCMFieldTag	keyFieldTag,
		ByteCount	keySize,
		ConstLogicalAddress	keyData,
		DCMUniqueID	uniqueID
	)

DCMDeleteRecord()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMDeriveNewDictionary()

OSStatus DCMDeriveNewDictionary	(	DCMDictionaryID	srcDictionary,
		const FSSpec *	newDictionaryFile,
		ScriptCode	scriptTag,
		Boolean	invisible,
		ItemCount	recordCapacity,
		DCMDictionaryID *	newDictionary
	)

DCMDeriveNewDictionary()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMDisposeObjectIterator()

OSStatus DCMDisposeObjectIterator ( DCMObjectIterator iterator )

DCMDisposeObjectIterator()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMDisposeRecordIterator()

OSStatus DCMDisposeRecordIterator ( DCMFoundRecordIterator recordIterator )

DCMDisposeRecordIterator()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMFindRecords()

OSStatus DCMFindRecords	(	DCMDictionaryRef	dictionaryRef,
		DCMFieldTag	keyFieldTag,
		ByteCount	keySize,
		ConstLogicalAddress	keyData,
		DCMFindMethod	findMethod,
		ItemCount	preFetchedDataNum,
		DCMFieldTag	preFetchedData[],
		ItemCount	skipCount,
		ItemCount	maxRecordCount,
		DCMFoundRecordIterator *	recordIterator
	)

Find records DCMFindRecords()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetAccessMethodIDFromName()

OSStatus DCMGetAccessMethodIDFromName	(	ConstStr63Param	accessMethodName,
		DCMAccessMethodID *	accessMethodID
	)

Get AccessMethod information DCMGetAccessMethodIDFromName()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetDictionaryFieldInfo()

OSStatus DCMGetDictionaryFieldInfo	(	DCMDictionaryID	dictionaryID,
		DCMFieldTag	fieldTag,
		AEDesc *	fieldInfoRecord
	)

Field information and manipulation DCMGetDictionaryFieldInfo()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetDictionaryIDFromFile()

OSStatus DCMGetDictionaryIDFromFile	(	const FSSpec *	fileRef,
		DCMDictionaryID *	dictionaryID
	)

DCMGetDictionaryIDFromFile()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetDictionaryIDFromRef()

DCMDictionaryID DCMGetDictionaryIDFromRef ( DCMDictionaryRef dictionaryRef )

DCMGetDictionaryIDFromRef()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetDictionaryProperty()

OSStatus DCMGetDictionaryProperty	(	DCMDictionaryID	dictionaryID,
		DCMFieldTag	propertyTag,
		ByteCount	maxPropertySize,
		ByteCount *	actualSize,
		LogicalAddress	propertyValue
	)

Dictionary property DCMGetDictionaryProperty()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetDictionaryPropertyList()

OSStatus DCMGetDictionaryPropertyList	(	DCMDictionaryID	dictionaryID,
		ItemCount	maxPropertyNum,
		ItemCount *	numProperties,
		DCMFieldTag	propertyTag[]
	)

DCMGetDictionaryPropertyList()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetDictionaryWriteAccess()

OSStatus DCMGetDictionaryWriteAccess	(	DCMDictionaryRef	dictionaryRef,
		Duration	timeOutDuration
	)

Change access privilege DCMGetDictionaryWriteAccess()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetFieldAttributes()

OSStatus DCMGetFieldAttributes	(	const AEDesc *	fieldInfoRecord,
		DCMFieldAttributes *	attributes
	)

DCMGetFieldAttributes()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetFieldData()

OSStatus DCMGetFieldData	(	DCMDictionaryRef	dictionaryRef,
		DCMFieldTag	keyFieldTag,
		ByteCount	keySize,
		ConstLogicalAddress	keyData,
		DCMUniqueID	uniqueID,
		ItemCount	numOfData,
		const DCMFieldTag	dataTag[],
		AEDesc *	dataList
	)

Get field data DCMGetFieldData()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetFieldDefaultData()

OSStatus DCMGetFieldDefaultData	(	const AEDesc *	fieldInfoRecord,
		DescType	desiredType,
		AEDesc *	fieldDefaultData
	)

DCMGetFieldDefaultData()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetFieldFindMethods()

OSStatus DCMGetFieldFindMethods	(	const AEDesc *	fieldInfoRecord,
		ItemCount	findMethodsArrayMaxSize,
		DCMFindMethod	findMethods[],
		ItemCount *	actualNumberOfFindMethods
	)

DCMGetFieldFindMethods()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetFieldMaxRecordSize()

OSStatus DCMGetFieldMaxRecordSize	(	const AEDesc *	fieldInfoRecord,
		ByteCount *	maxRecordSize
	)

DCMGetFieldMaxRecordSize()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetFieldTagAndType()

OSStatus DCMGetFieldTagAndType	(	const AEDesc *	fieldInfoRecord,
		DCMFieldTag *	fieldTag,
		DCMFieldType *	fieldType
	)

DCMGetFieldTagAndType()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetFileFromDictionaryID()

OSStatus DCMGetFileFromDictionaryID	(	DCMDictionaryID	dictionaryID,
		FSSpec *	fileRef
	)

DictionaryID utilities DCMGetFileFromDictionaryID()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetNextRecord()

OSStatus DCMGetNextRecord	(	DCMDictionaryRef	dictionaryRef,
		DCMFieldTag	keyFieldTag,
		ByteCount	keySize,
		ConstLogicalAddress	keyData,
		DCMUniqueID	uniqueID,
		ByteCount	maxKeySize,
		ByteCount *	nextKeySize,
		LogicalAddress	nextKeyData,
		DCMUniqueID *	nextUniqueID
	)

DCMGetNextRecord()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetNthRecord()

OSStatus DCMGetNthRecord	(	DCMDictionaryRef	dictionaryRef,
		DCMFieldTag	keyFieldTag,
		ItemCount	serialNum,
		ByteCount	maxKeySize,
		ByteCount *	keySize,
		LogicalAddress	keyData,
		DCMUniqueID *	uniqueID
	)

DCMGetNthRecord()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetPrevRecord()

OSStatus DCMGetPrevRecord	(	DCMDictionaryRef	dictionaryRef,
		DCMFieldTag	keyFieldTag,
		ByteCount	keySize,
		ConstLogicalAddress	keyData,
		DCMUniqueID	uniqueID,
		ByteCount	maxKeySize,
		ByteCount *	prevKeySize,
		LogicalAddress	prevKeyData,
		DCMUniqueID *	prevUniqueID
	)

DCMGetPrevRecord()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMGetRecordSequenceNumber()

OSStatus DCMGetRecordSequenceNumber	(	DCMDictionaryRef	dictionaryRef,
		DCMFieldTag	keyFieldTag,
		ByteCount	keySize,
		ConstLogicalAddress	keyData,
		DCMUniqueID	uniqueID,
		ItemCount *	sequenceNum
	)

DCMGetRecordSequenceNumber()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMIterateFoundRecord()

OSStatus DCMIterateFoundRecord	(	DCMFoundRecordIterator	recordIterator,
		ByteCount	maxKeySize,
		ByteCount *	actualKeySize,
		LogicalAddress	keyData,
		DCMUniqueID *	uniqueID,
		AEDesc *	dataList
	)

DCMIterateFoundRecord()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMIterateObject()

OSStatus DCMIterateObject	(	DCMObjectIterator	iterator,
		DCMObjectID *	objectID
	)

DCMIterateObject()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMLibraryVersion()

UInt32 DCMLibraryVersion ( void )

Library version DCMLibraryVersion()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMNewDictionary()

OSStatus DCMNewDictionary	(	DCMAccessMethodID	accessMethodID,
		const FSSpec *	newDictionaryFile,
		ScriptCode	scriptTag,
		const AEDesc *	listOfFieldInfoRecords,
		Boolean	invisible,
		ItemCount	recordCapacity,
		DCMDictionaryID *	newDictionary
	)

Create/delete dictionary DCMNewDictionary()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMOpenDictionary()

OSStatus DCMOpenDictionary	(	DCMDictionaryID	dictionaryID,
		ByteCount	protectKeySize,
		ConstLogicalAddress	protectKey,
		DCMDictionaryRef *	dictionaryRef
	)

Open dictionary DCMOpenDictionary()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMRegisterDictionaryFile()

OSStatus DCMRegisterDictionaryFile	(	const FSSpec *	dictionaryFile,
		DCMDictionaryID *	dictionaryID
	)

Register dictionary DCMRegisterDictionaryFile()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMReleaseDictionaryWriteAccess()

OSStatus DCMReleaseDictionaryWriteAccess	(	DCMDictionaryRef	dictionaryRef,
		Boolean	commitTransaction
	)

DCMReleaseDictionaryWriteAccess()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMReorganizeDictionary()

OSStatus DCMReorganizeDictionary	(	DCMDictionaryID	dictionaryID,
		ItemCount	extraCapacity,
		DCMProgressFilterUPP	progressProc,
		UInt32	userData
	)

Reorganize/compact dictionary DCMReorganizeDictionary()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMResetObjectIterator()

OSStatus DCMResetObjectIterator ( DCMObjectIterator iterator )

DCMResetObjectIterator()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMSetDictionaryProperty()

OSStatus DCMSetDictionaryProperty	(	DCMDictionaryID	dictionaryID,
		DCMFieldTag	propertyTag,
		ByteCount	propertySize,
		ConstLogicalAddress	propertyValue
	)

DCMSetDictionaryProperty()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMSetFieldData()

OSStatus DCMSetFieldData	(	DCMDictionaryRef	dictionaryRef,
		DCMFieldTag	keyFieldTag,
		ByteCount	keySize,
		ConstLogicalAddress	keyData,
		DCMUniqueID	uniqueID,
		const AEDesc *	dataList
	)

DCMSetFieldData()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DCMUnregisterDictionary()

OSStatus DCMUnregisterDictionary ( DCMDictionaryID dictionaryID )

DCMUnregisterDictionary()

Non-Carbon CFM: in DictionaryMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DeleteRecordFromDictionary()

OSErr DeleteRecordFromDictionary	(	SInt32	dictionaryReference,
		ConstStr255Param	key
	)

DeleteRecordFromDictionary()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ DisposeDCMProgressFilterUPP()

void DisposeDCMProgressFilterUPP ( DCMProgressFilterUPP userUPP )

DisposeDCMProgressFilterUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ FindRecordByIndexInDictionary()

OSErr FindRecordByIndexInDictionary	(	SInt32	dictionaryReference,
		SInt32	recordIndex,
		DictionaryAttributeTablePtr	requestedAttributeTablePointer,
		Str255	recordKey,
		Handle	recordDataHandle
	)

FindRecordByIndexInDictionary()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ FindRecordInDictionary()

OSErr FindRecordInDictionary	(	SInt32	dictionaryReference,
		ConstStr255Param	key,
		DictionaryAttributeTablePtr	requestedAttributeTablePointer,
		Handle	recordDataHandle
	)

FindRecordInDictionary()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ GetDictionaryInformation()

OSErr GetDictionaryInformation	(	SInt32	dictionaryReference,
		DictionaryInformation *	theDictionaryInformation
	)

GetDictionaryInformation()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ InitializeDictionary()

OSErr InitializeDictionary	(	const FSSpec *	theFsspecPtr,
		SInt16	maximumKeyLength,
		SInt8	keyAttributes,
		ScriptCode	script
	)

InitializeDictionary()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ InsertRecordToDictionary()

OSErr InsertRecordToDictionary	(	SInt32	dictionaryReference,
		ConstStr255Param	key,
		Handle	recordDataHandle,
		DictionaryDataInsertMode	whichMode
	)

InsertRecordToDictionary()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ InvokeDCMProgressFilterUPP()

Boolean InvokeDCMProgressFilterUPP	(	Boolean	determinateProcess,
		UInt16	percentageComplete,
		UInt32	callbackUD,
		DCMProgressFilterUPP	userUPP
	)

InvokeDCMProgressFilterUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ NewDCMProgressFilterUPP()

DCMProgressFilterUPP NewDCMProgressFilterUPP ( DCMProgressFilterProcPtr userRoutine )

NewDCMProgressFilterUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ OpenDictionary()

OSErr OpenDictionary	(	const FSSpec *	theFsspecPtr,
		SInt8	accessPermission,
		SInt32 *	dictionaryReference
	)

OpenDictionary()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ CallDCMProgressFilterProc

◆ InvokeDCMProgressFilterUPP

◆ kAppleJapaneseDefaultAccessMethodName

Definitions for Japanese Analysis Module

◆ NewDCMProgressFilterUPP

Typedef Documentation

◆ DCMFieldTag

Enumeration Type Documentation

◆ anonymous enum

Modern Dictionary Manager

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

System 7 Dictionary Manager

Function Documentation

◆ CALLBACK_API()

◆ CloseDictionary()

◆ CompactDictionary()

◆ DCMAddRecord()

◆ DCMCloseDictionary()

◆ DCMCompactDictionary()

◆ DCMCountObjectIterator()

◆ DCMCountRecord()

◆ DCMCountRecordIterator()

◆ DCMCreateAccessMethodIterator()

◆ DCMCreateDictionaryIterator()

◆ DCMCreateFieldInfoRecord()

◆ DCMDeleteDictionary()

◆ DCMDeleteRecord()

◆ DCMDeriveNewDictionary()

◆ DCMDisposeObjectIterator()

◆ DCMDisposeRecordIterator()

◆ DCMFindRecords()

◆ DCMGetAccessMethodIDFromName()

◆ DCMGetDictionaryFieldInfo()

◆ DCMGetDictionaryIDFromFile()

◆ DCMGetDictionaryIDFromRef()

◆ DCMGetDictionaryProperty()

◆ DCMGetDictionaryPropertyList()

◆ DCMGetDictionaryWriteAccess()

◆ DCMGetFieldAttributes()

◆ DCMGetFieldData()

◆ DCMGetFieldDefaultData()

◆ DCMGetFieldFindMethods()

◆ DCMGetFieldMaxRecordSize()

◆ DCMGetFieldTagAndType()

◆ DCMGetFileFromDictionaryID()

◆ DCMGetNextRecord()

◆ DCMGetNthRecord()

◆ DCMGetPrevRecord()

◆ DCMGetRecordSequenceNumber()

◆ DCMIterateFoundRecord()

◆ DCMIterateObject()

◆ DCMLibraryVersion()

◆ DCMNewDictionary()

◆ DCMOpenDictionary()

◆ DCMRegisterDictionaryFile()

◆ DCMReleaseDictionaryWriteAccess()

◆ DCMReorganizeDictionary()

◆ DCMResetObjectIterator()

◆ DCMSetDictionaryProperty()

◆ DCMSetFieldData()

◆ DCMUnregisterDictionary()

◆ DeleteRecordFromDictionary()