Next Page >

Hide TOC

Code Fragment Manager Reference

Framework	CoreServices/CoreServices.h
Declared in	CodeFragments.h

Overview

This chapter describes the Code Fragment Manager, the part of the Mac OS that loads fragments into memory and prepares them for execution. A fragment can be an application, an import library, a system extension, or any other block of executable code and its associated data.

The Code Fragment Manager is intended to operate transparently to most applications and other software. You need to use the Code Fragment Manager explicitly only if

you need to load code modules dynamically during the execution of your application or other software
you want to unload code modules before the termination of your application
you want to obtain information about the symbols exported by a fragment

For example, if your application supports dynamic loading of tools, filters, or other software modules contained in fragments, you'll need to use the Code Fragment Manager to load and prepare them for execution.

Carbon supports the Code Fragment Manager.

Functions by Task

Finding Symbols

Loading Fragments

Unloading Fragments

Converting a Bundle Prelocator

Callbacks

CFragInitFunction

Defines a fragment initialization function that is executed by the Code Fragment Manager when the fragment is first loaded into memory and prepared for execution.

typedef OSErr (*CFragInitFunction) (
   const CFragInitBlock * initBlock
);

If you name your function MyCFragInitFunction, you would declare it like this:

OSErr MyCFragInitFunction (
   const CFragInitBlock * initBlock
);

Parameters

initBlock: A pointer to a fragment initialization block specifying information about the fragment.

Return Value

A result code. See “Code Fragment Manager Result Codes.” Your initialization function should return noErr if it executes successfully, and some other result code if it does not. If your initialization function returns any result code other than noErr, the entire load fails and the error fragUserInitProcErr is returned to the code that requested the root load.

Discussion

A fragment’s initialization function is executed immediately before the fragment’s main function (if it has one) is executed. The initialization function is passed a pointer to an initialization block, which contains information about the fragment, such as its location and connection ID. See InitBlock for a description of the fields of the initialization block.

You can use the initialization function to perform any tasks that need to be performed before any of the code or data in the fragment is accessed. For example, you might want to open the fragment’s resource fork (if it has one). You can determine the location of the fragment’s container from the FragmentLocator field of the fragment initialization block whose address is passed to your initialization function.

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragTermProcedure

Defines a pointer to a fragment termination function that is executed by the Code Fragment Manager when the fragment is unloaded from memory.

typedef void (*CFragTermProcedure) (
);

If you name your function MyCFragTermProcedure, you would declare it like this:

void MyCFragTermProcedure ();

Discussion

A fragment’s termination function is executed immediately before the fragment is unloaded from memory. You can use the termination function to perform any necessary clean-up tasks, such as closing open resource files or disposing of any memory allocated by the fragment.

Note that a termination function is not passed any parameters and does not return any result. You are expected to maintain any information about the fragment (such as file reference numbers of any open files) in its static data area.

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

Data Types

CFragCFBundleLocator

struct CFragCFBundleLocator {
   CFBundleRef fragmentBundle;
   UInt32 offset;
   UInt32 length;
};
typedef struct CFragCFBundleLocator CFragCFBundleLocator;

Fields

fragmentBundle
offset
length

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragClosureID

typedef struct OpaqueCFragClosureID * CFragClosureID;

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragConnectionID

typedef struct OpaqueCFragConnectionID * CFragConnectionID;

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragContainerID

typedef struct OpaqueCFragContainerID * CFragContainerID;

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragContextID

typedef MPProcessID CFragContextID;

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragHFSDiskFlatLocator

typedef CFragSystem7DiskFlatLocator CFragHFSDiskFlatLocator;

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

CFragHFSLocator

typedef CFragSystem7Locator CFragHFSLocator;

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

CFragHFSLocatorPtr

typedef CFragSystem7LocatorPtr CFragHFSLocatorPtr;

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

CFragHFSMemoryLocator

typedef CFragSystem7MemoryLocator CFragHFSMemoryLocator;

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

CFragHFSSegmentedLocator

typedef CFragSystem7SegmentedLocator CFragHFSSegmentedLocator;

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

CFragInitBlock

typedef CFragSystem7InitBlock CFragInitBlock;

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragInitBlockPtr

typedef CFragSystem7InitBlockPtr CFragInitBlockPtr;

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragResource

struct CFragResource {
   UInt32 reservedA;
   UInt32 reservedB;
   UInt16 reservedC;
   UInt16 version;
   UInt32 reservedD;
   UInt32 reservedE;
   UInt32 reservedF;
   UInt32 reservedG;
   UInt16 reservedH;
   UInt16 memberCount;
   CFragResourceMember firstMember;
};
typedef struct CFragResource CFragResource;
typedef CFragResource * CFragResourcePtr;
typedef CFragResourcePtr * CFragResourceHandle;

Fields

reservedA: This field is reserved for future use. Set this field to 0.
reservedB: This field is reserved for future use. Set this field to 0.
reservedC: This field is reserved for future use. Set this field to 0.
version
reservedD: This field is reserved for future use. Set this field to 0.
reservedE: This field is reserved for future use. Set this field to 0.
reservedF: This field is reserved for future use. Set this field to 0.
reservedG: This field is reserved for future use. Set this field to 0.
reservedH: This field is reserved for future use. Set this field to 0.
memberCount
firstMember

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragResourceExtensionHeader

struct CFragResourceExtensionHeader {
   UInt16 extensionKind;
   UInt16 extensionSize;
};
typedef struct CFragResourceExtensionHeader CFragResourceExtensionHeader;
typedef CFragResourceExtensionHeader * CFragResourceExtensionHeaderPtr;

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragResourceMember

struct CFragResourceMember {
   CFragArchitecture architecture;
   UInt16 reservedA;
   UInt8 reservedB;
   UInt8 updateLevel;
   CFragVersionNumber currentVersion;
   CFragVersionNumber oldDefVersion;
   CFragUsage1Union uUsage1;
   CFragUsage2Union uUsage2;
   CFragUsage usage;
   CFragLocatorKind where;
   UInt32 offset;
   UInt32 length;
   CFragWhere1Union uWhere1;
   CFragWhere2Union uWhere2;
   UInt16 extensionCount;
   UInt16 memberSize;
   unsigned char name[16];
};
typedef struct CFragResourceMember CFragResourceMember;
typedef CFragResourceMember * CFragResourceMemberPtr;

Fields

architecture
reservedA: This field is reserved. Set to 0.
reservedB: This field is reserved. Set to 0.
updateLevel
currentVersion
oldDefVersion
uUsage1
uUsage2
usage
where
offset
length
uWhere1
uWhere2
extensionCount: Specifies the number of extensions beyond the name.
memberSize: Specifies the size in bytes, including all extensions.
name

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragResourceSearchExtension

struct CFragResourceSearchExtension {
   CFragResourceExtensionHeader header;
   OSType libKind;
   unsigned char qualifiers[1];
};
typedef struct CFragResourceSearchExtension CFragResourceSearchExtension;
typedef CFragResourceSearchExtension * CFragResourceSearchExtensionPtr;

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragSystem7DiskFlatLocator

Defines a disk location structure.

struct CFragSystem7DiskFlatLocator {
   FSSpec * fileSpec;
   UInt32 offset;
   UInt32 length;
};
typedef struct CFragSystem7DiskFlatLocator CFragSystem7DiskFlatLocator;
typedef CFragSystem7DiskFlatLocator DiskFragment;

Fields

fileSpec: A pointer to a file specification structure (a data structure of type FSSpec) for the data fork of a file. This pointer is valid only while the initialization function is executing. If you need to access the information in the file specification structure at any later time, you must make a copy of that structure.
offset: The offset, in bytes, from the beginning of the file’s data fork to the beginning of the fragment.
length: The length, in bytes, of the fragment. If this field contains the value 0, the fragment extends to the end-of-file.

Discussion

For fragments located in the data fork of a file on disk, the onDisk field of a fragment location structure contains a disk location structure, which specifies the location of the fragment.

The fields of a fragment initialization block are aligned in memory in accordance with 680x0 alignment conventions.

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragSystem7InitBlock

struct CFragSystem7InitBlock {
   CFragContextID contextID;
   CFragClosureID closureID;
   CFragConnectionID connectionID;
   CFragSystem7Locator fragLocator;
   StringPtr libName;
   UInt32 reservedA;
};
typedef struct CFragSystem7InitBlock CFragSystem7InitBlock;
typedef CFragSystem7InitBlock * CFragSystem7InitBlock;
typedef CFragSystem7InitBlock CFragInitBlock;

Fields

contextID: A context ID.
closureID: A closure ID.
connectionID: A connection ID.
fragLocator: A fragment location structure, CFragSystem7Locator that specifies the location of the fragment.
libName: A pointer to the name of the fragment being initialized. The name is a Pascal string (a length byte followed by the name itself).
reservedA: Reserved for use by Apple Computer.

Discussion

The Code Fragment Manager passes to your fragment’s initialization function a pointer to a fragment initialization block, which contains information about the fragment. A fragment initialization block is defined by the InitBlock data type.

The fields of a fragment initialization block are aligned in memory in accordance with 680x0 alignment conventions.

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragSystem7Locator

Defines a fragment location structure.

struct CFragSystem7Locator {
   SInt32 where
   union {
      CFragSystem7DiskFlatLocator onDisk;
      CFragSystem7MemoryLocator inMem;
      CFragSystem7SegmentedLocator inSegs;
      CFragCFBundleLocator inBundle;
   } u;
};
typedef struct CFragSystem7Locator CFragSystem7Locator;
typedef CFragSystem7Locator * CFragSystem7LocatorPtr;
typedef CFragSystem7Locator FragmentLocator;

Fields

where: A selector that determines which member of the following union is relevant. This field can contain one of the constants described in “Load Flag, Symbol Class, and Fragment Locator Constants.”
u: If the where field has the value kOnDiskFlat, a disk location structure.

Discussion

The fragLocator field of an initialization block contains a fragment location structure that provides information about the location of a fragment.

The fields of a fragment initialization block are aligned in memory in accordance with 680x0 alignment conventions.

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragSystem7MemoryLocator

Defines a memory location structure.

struct CFragSystem7MemoryLocator {
   LogicalAddress address;
   UInt32 length;
   Boolean inPlace;
   UInt8 reservedA;
   UInt16 reservedB;
};
typedef struct CFragSystem7MemoryLocator CFragSystem7MemoryLocator;
typedef CFragSystem7MemoryLocator MemFragment;

Fields

address: A pointer to the beginning of the fragment in memory.
length: The length, in bytes, of the fragment.
inPlace: A Boolean value that specifies whether the container’s data section is instantiated in place (true) or elsewhere (false).
reservedA: This field is reserved for future use. Set to 0.
reservedB: This field is reserved for future use. Set to 0.

Discussion

For fragments located in memory, the inMem field of a fragment location structure contains a memory location structure, which specifies the location of the fragment in memory.

The fields of a fragment initialization block are aligned in memory in accordance with 680x0 alignment conventions.

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragSystem7SegmentedLocator

Defines a segment location structure.

struct CFragSystem7SegmentedLocator {
   FSSpec * fileSpec;
   OSType rsrcType;
   SInt16 rsrcID;
   UInt16 reservedA;
};
typedef struct CFragSystem7SegmentedLocator CFragSystem7SegmentedLocator;
typedef CFragSystem7SegmentedLocator SegmentedFragment;

Fields

fileSpec: A pointer to a file specification structure (a data structure of type FSSpec) for the resource fork of a file. This pointer is valid only while the initialization function is executing. If you need to access the information in the file specification structure at any later time, you must make a copy of that structure.
rsrcType: The resource type of the resource containing the fragment.
rsrcID: The resource ID of the resource containing the fragment.
reservedA: This field is reserved for future use.

Discussion

For fragments located in the resource fork of a file on disk, the inSegs field of a fragment location structure contains a segment location structure, which specifies the location of the fragment.

The fields of a fragment initialization block are aligned in memory in accordance with 680x0 alignment conventions.

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragUsage1Union

union CFragUsage1Union {
   UInt32 appStackSize;
};
typedef union CFragUsage1Union CFragUsage1Union;

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragUsage2Union

union CFragUsage2Union {
   SInt16 appSubdirID;
   UInt16 libFlags;
};
typedef union CFragUsage2Union CFragUsage2Union;

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragWhere1Union

union CFragWhere1Union {
   UInt32 spaceID;
};
typedef union CFragWhere1Union CFragWhere1Union;

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

CFragWhere2Union

union CFragWhere2Union {
   UInt16 reserved;
};
typedef union CFragWhere2Union CFragWhere2Union;

Availability

Available in Mac OS X v10.0 and later.
Not available to 64-bit applications.

Declared In

CodeFragments.h

ConnectionID

typedef CFragConnectionID ConnectionID;

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

DiskFragment

A CFragSystem7DiskFlatLocator structure.

typedef CFragSystem7DiskFlatLocator DiskFragment;

Discussion

See CFragSystem7DiskFlatLocator.

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

FragmentLocator

A CFragSystem7Locator structure.

typedef CFragSystem7Locator FragmentLocator;

Discussion

See CFragSystem7Locator.

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

FragmentLocatorPtr

typedef CFragSystem7LocatorPtr FragmentLocatorPtr;

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

InitBlock

typedef CFragInitBlock InitBlock;

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

InitBlockPtr

typedef CFragInitBlockPtr InitBlockPtr;

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

LoadFlags

typedef CFragLoadOptions LoadFlags;

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

MemFragment

A CFragSystem7MemoryLocator structure.

typedef CFragSystem7MemoryLocator MemFragment;

Discussion

See CFragSystem7MemoryLocator.

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

SegmentedFragment

A CFragSystem7SegmentedLocator structure.

typedef CFragSystem7SegmentedLocator SegmentedFragment;

Discussion

See CFragSystem7SegmentedLocator.

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

SymClass

typedef CFragSymbolClass SymClass;

Availability

Available in Mac OS X v10.0 and later.

Declared In

CodeFragments.h

Constants

Architecture Constants

typedef OSType CFragArchitecture;
enum {
   kPowerPCCFragArch = 'pwpc',
   kMotorola68KCFragArch = 'm68k',
   kAnyCFragArch = 0x3F3F3F3F
};

Constants

kPowerPCCFragArch

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kMotorola68KCFragArch

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kAnyCFragArch

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

Code Fragment Kind

enum {
   kIsCompleteCFrag = 0,
   kFirstCFragUpdate = 1
};

Constants

kIsCompleteCFrag

Indicates a base fragment rather than an update.

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kFirstCFragUpdate

Indicates the first update, others are numbered starting with 2.

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

Current Resource Version

enum {
   kCurrCFragResourceVersion = 1
};

Default Name Length

enum {
   kDefaultCFragNameLen = 16
};

File Location

#define IsFileLocation CFragHasFileLocation;

kCFragGoesToEOF

enum {
   kCFragGoesToEOF = 0
};

kCFragLibUsageMapPrivatelyMask

enum {
   kCFragLibUsageMapPrivatelyMask = 0x0001
};

Constants

kCFragLibUsageMapPrivatelyMask

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kCFragResourceSearchExtensionKind

enum {
   kCFragResourceSearchExtensionKind = 0x30EE
};

kCFragResourceType

enum {
   kCFragResourceType = 'cfrg',
   kCFragResourceID = 0,
   kCFragLibraryFileType = 'shlb',
   kCFragAllFileTypes = 0xFFFFFFFF
};

Constants

kCFragResourceType

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kCFragResourceID

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kCFragLibraryFileType

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kCFragAllFileTypes

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kCompiledCFragArch

enum {
   kCompiledCFragArch = 'kPowerPCCFragArch'
};

Constants

kCompiledCFragArch

The value for this constant is 'kPowerPCCFragArch' if you have defined TARGET_CPU_PPC. If you define TARGET_CPU_X86, then the value of this constant is 'none'

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kLoadCFrag

enum {
   kLoadCFrag = kReferenceCFrag
};

Constants

kLoadCFrag

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kPowerPC

enum {
   kPowerPC = kPowerPCCFragArch,
   kMotorola68K = kMotorola68KCFragArch
};

Constants

kPowerPC

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kMotorola68K

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

Load Flag, Symbol Class, and Fragment Locator Constants

enum {
   kPowerPCArch = kPowerPCCFragArch,
   kMotorola68KArch = kMotorola68KCFragArch,
   kAnyArchType = kAnyCFragArch,
   kNoLibName = 0,
   kNoConnectionID = 0,
   kLoadLib = kLoadCFrag,
   kFindLib = kFindCFrag,
   kNewCFragCopy = kPrivateCFragCopy,
   kLoadNewCopy = kPrivateCFragCopy,
   kUseInPlace = 0x80,
   kCodeSym = kCodeCFragSymbol,
   kDataSym = kDataCFragSymbol,
   kTVectSym = kTVectorCFragSymbol,
   kTOCSym = kTOCCFragSymbol,
   kGlueSym = kGlueCFragSymbol,
   kInMem = kMemoryCFragLocator,
   kOnDiskFlat = kDataForkCFragLocator,
   kOnDiskSegmented = kResourceCFragLocator,
   kIsLib = kImportLibraryCFrag,
   kIsApp = kApplicationCFrag,
   kIsDropIn = kDropInAdditionCFrag,
   kFullLib = kIsCompleteCFrag,
   kUpdateLib = kFirstCFragUpdate,
   kWholeFork = kCFragGoesToEOF,
   kCFMRsrcType = kCFragResourceType,
   kCFMRsrcID = kCFragResourceID,
   kSHLBFileType = kCFragLibraryFileType,
   kUnresolvedSymbolAddress = kUnresolvedCFragSymbolAddress
};

Constants

kPowerPCArch

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kMotorola68KArch

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kAnyArchType

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kNoLibName

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kNoConnectionID

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kLoadLib

Specifies that the Code Fragment Manager search for the specified fragment.

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kFindLib

Specifies that the Code Fragment Manager search for the specified fragment and, if it finds it, load it into memory. If the fragment has already been loaded, it is not loaded again. The Code Fragment Manager uses the data-instantiation method specified in the fragment’s container (which is either global or per-connection instantiation).

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kNewCFragCopy

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kLoadNewCopy

Specifies that the Code Fragment Manager load the specified fragment, creating a new copy of any writable data maintained by the fragment. You specify kLoadNewCopy to obtain one instance per load of the fragment’s data and to override the data-instantiation method specified in the container itself. This is most useful for application extensions (for example, drop-in tools).

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kUseInPlace

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kCodeSym

Specifies a code symbol.

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kDataSym

Specifies a data symbol.

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kTVectSym

Specifies a transition vector symbol.

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kTOCSym

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kGlueSym

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kInMem

Specifies that the container is in memory. If used in the where parameter of a FragmentLocator structure, the relevant member of the union is a CFragSystem7SegmentedLocator structure.

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kOnDiskFlat

Specifies that the container is in a data fork. If used in the where parameter of a FragmentLocator structure, the relevant member of the union is a CFragSystem7SegmentedLocator structure.

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kOnDiskSegmented

Specifies that the container is in a resource. If used in the where parameter of a FragmentLocator structure, the relevant member of the union is a CFragSystem7SegmentedLocator structure.

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kIsLib

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kIsApp

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kIsDropIn

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kFullLib

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kUpdateLib

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kWholeFork

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kCFMRsrcType

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kCFMRsrcID

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kSHLBFileType

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

kUnresolvedSymbolAddress

Available in Mac OS X v10.0 and later.

Declared in CodeFragments.h

Discussion

The load flag constants (kLoadLib, kFindLib, and kLoadNewCopy) are used in the loadFlags parameter of the GetDiskFragment, GetMemFragment, and GetSharedLibrary functions to specify the action taken by those functions.

The symbol class constants (kCodeSym, kDataSym, and kTVectSym) are returned in the symClass parameter of the FindSymbol function to specify the class of the specified symbol.

The fragment locator constants (kInMem, kOnDiskFlat, and kOnDiskSegmented) are used in the where field of the FragmentLocator structure to indicate which member of the union u is relevant.

Load Options

typedef OptionBits CFragLoadOptions;
enum {
   kReferenceCFrag = 0x0001,
   kFindCFrag = 0x0002,
   kPrivateCFragCopy = 0x0005
};

Constants

kReferenceCFrag

Try to use existing copy, increment reference counts.

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kFindCFrag

Try find an existing copy, do not increment reference counts.

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kPrivateCFragCopy

Prepare a new private copy.

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

Locator Kind

typedef UInt8 CFragLocatorKind;
enum {
   kMemoryCFragLocator = 0,
   kDataForkCFragLocator = 1,
   kResourceCFragLocator = 2,
   kNamedFragmentCFragLocator = 4,
   kCFBundleCFragLocator = 5,
   kCFBundlePreCFragLocator = 6
};

Constants

kMemoryCFragLocator

Indicates the container is in memory.

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kDataForkCFragLocator

Indicates the container is in a file’s data fork.

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kResourceCFragLocator

Indicates the container is in a file’s resource fork.

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kNamedFragmentCFragLocator

This constant is reserved for future use.

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kCFBundleCFragLocator

Indicates the container is in the executable of a CFBundle.

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kCFBundlePreCFragLocator

Indicates it was passed to the initialization routines in lieu of kCFBundleCFragLocator

Available in Mac OS X v10.1 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

Symbol Class Constants

typedef UInt8 CFragSymbolClass;
enum {
   kCodeCFragSymbol = 0,
   kDataCFragSymbol = 1,
   kTVectorCFragSymbol = 2,
   kTOCCFragSymbol = 3,
   kGlueCFragSymbol = 4
};

Constants

kCodeCFragSymbol

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kDataCFragSymbol

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kTVectorCFragSymbol

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kTOCCFragSymbol

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kGlueCFragSymbol

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

Unresolved Symbol Address

enum {
   kUnresolvedCFragSymbolAddress = 0
};

Constants

kUnresolvedCFragSymbolAddress

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

Usage Constants

typedef UInt8 CFragUsage;
enum {
   kImportLibraryCFrag = 0,
   kApplicationCFrag = 1,
   kDropInAdditionCFrag = 2,
   kStubLibraryCFrag = 3,
   kWeakStubLibraryCFrag = 4
};

Constants

kImportLibraryCFrag

Indicates a standard CFM import library.

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kApplicationCFrag

Indicates a MacOS application.

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kDropInAdditionCFrag

Indicates an application or library private extension/plug-in.

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kStubLibraryCFrag

Indicates an import library used for linking only

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kWeakStubLibraryCFrag

Indicates an import library used for linking only and will be automatically weak linked

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

Version Number

typedef UInt32 CFragVersionNumber;
enum {
   kNullCFragVersion = 0,
   kWildcardCFragVersion = 0xFFFFFFFF
};

Constants

kNullCFragVersion

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

kWildcardCFragVersion

Available in Mac OS X v10.0 and later.

Not available to 64-bit applications.

Declared in CodeFragments.h

Result Codes

The most common result codes returned by Code Fragment Manager are listed in the table below. The Code Fragment Manager may also return paramErr (-50).

Result Code	Value	Description
`cfragContextIDErr`	-2800	The context ID was not valid. Available in Mac OS X v10.0 and later.
`cfragFirstErrCode`	-2800	The first value in the range of CFM errors. Available in Mac OS X v10.0 and later.
`cfragConnectionIDErr`	-2801	The connection ID was not valid. Available in Mac OS X v10.0 and later.
`cfragNoSymbolErr`	-2802	The specified symbol was not found. Available in Mac OS X v10.0 and later.
`cfragNoSectionErr`	-2803	The specified section was not found. Available in Mac OS X v10.0 and later.
`cfragNoLibraryErr`	-2804	The named library was not found. Available in Mac OS X v10.0 and later.
`cfragDupRegistrationErr`	-2805	The registration name was already in use. Available in Mac OS X v10.0 and later.
`cfragFragmentFormatErr`	-2806	A fragment's container format is unknown. Available in Mac OS X v10.0 and later.
`cfragUnresolvedErr`	-2807	A fragment had "hard" unresolved imports. Available in Mac OS X v10.0 and later.
`cfragNoPositionErr`	-2808	The registration insertion point was not found. Available in Mac OS X v10.0 and later.
`cfragNoPrivateMemErr`	-2809	Out of memory for internal bookkeeping. Available in Mac OS X v10.0 and later.
`cfragNoClientMemErr`	-2810	Out of memory for fragment mapping or section instances. Available in Mac OS X v10.0 and later.
`cfragNoIDsErr`	-2811	No more CFM IDs for contexts, connections, etc. Available in Mac OS X v10.0 and later.
`cfragInitOrderErr`	-2812	Available in Mac OS X v10.0 and later.
`cfragImportTooOldErr`	-2813	An import library was too old for a client. Available in Mac OS X v10.0 and later.
`cfragImportTooNewErr`	-2814	An import library was too new for a client. Available in Mac OS X v10.0 and later.
`cfragInitLoopErr`	-2815	Circularity in required initialization order. Available in Mac OS X v10.0 and later.
`cfragInitAtBootErr`	-2816	A boot library has an initialization function. (System 7 only) Available in Mac OS X v10.0 and later.
`cfragCFMStartupErr`	-2818	Internal error during CFM initialization. Available in Mac OS X v10.0 and later.
`cfragCFMInternalErr`	-2819	An internal inconsistency has been detected. Available in Mac OS X v10.0 and later.
`cfragFragmentCorruptErr`	-2820	A fragment's container was corrupt (known format). Available in Mac OS X v10.0 and later.
`cfragInitFunctionErr`	-2821	A fragment's initialization routine returned an error. Available in Mac OS X v10.0 and later.
`cfragNoApplicationErr`	-2822	No application member found in the cfrg resource. Available in Mac OS X v10.0 and later.
`cfragArchitectureErr`	-2823	A fragment has an unacceptable architecture. Available in Mac OS X v10.0 and later.
`cfragFragmentUsageErr`	-2824	A semantic error in usage of the fragment. Available in Mac OS X v10.0 and later.
`cfragFileSizeErr`	-2825	A file was too large to be mapped. Available in Mac OS X v10.0 and later.
`cfragNotClosureErr`	-2826	The closure ID was actually a connection ID. Available in Mac OS X v10.0 and later.
`cfragNoRegistrationErr`	-2827	The registration name was not found. Available in Mac OS X v10.0 and later.
`cfragContainerIDErr`	-2828	The fragment container ID was not valid. Available in Mac OS X v10.0 and later.
`cfragClosureIDErr`	-2829	The closure ID was not valid. Available in Mac OS X v10.0 and later.
`cfragAbortClosureErr`	-2830	Used by notification handlers to abort a closure. Available in Mac OS X v10.0 and later.
`cfragOutputLengthErr`	-2831	An output parameter is too small to hold the value. Available in Mac OS X v10.0 and later.
`cfragMapFileErr`	-2851	A file could not be mapped. Available in Mac OS X v10.4 and later.
`cfragExecFileRefErr`	-2854	Bundle does not have valid executable file. Available in Mac OS X v10.4 and later.
`cfragStdFolderErr`	-2855	Could not find standard CFM folder. Available in Mac OS X v10.4 and later.
`cfragRsrcForkErr`	-2856	Resource fork could not be opened. Available in Mac OS X v10.4 and later.
`cfragCFragRsrcErr`	-2857	`'cfrg'` resource could not be loaded. Available in Mac OS X v10.4 and later.
`cfragFirstReservedCode`	-2897	Reserved value for internal warnings. Available in Mac OS X v10.0 and later.
`cfragReservedCode_3`	-2897	Reserved value for internal warnings. Available in Mac OS X v10.0 and later.
`cfragReservedCode_2`	-2898	Reserved value for internal warnings. Available in Mac OS X v10.0 and later.
`cfragLastErrCode`	-2899	The last value in the range of CFM errors. Available in Mac OS X v10.0 and later.
`cfragReservedCode_1`	-2899	Available in Mac OS X v10.0 and later.

Next Page >

Hide TOC

Last updated: 2005-07-07

Did this document help you?
Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.




	Get information on Apple products. Visit the Apple Store online or at retail locations. 1-800-MY-APPLE Copyright © 2007 Apple Inc. All rights reserved. \| Terms of use \| Privacy Notice