Framework | Carbon/Carbon.h |
Declared in | InternetConfig.h |
Internet Config, a Mac OS 8 and 9 API, supports centralized entry and management of Internet preferences for all of a user’s Internet applications. For example, email programs and Web browsers can obtain a user's name, email address, home page, incoming mail server, and similar preferences from one common place that is easily edited by the user via the Internet Config application.
Mac OS X applications should employ Launch Services and System Configuration for managing Internet preferences. In Mac OS X, Internet Config calls through to these newer APIs. Using them directly increases your application’s efficiency.
If you use Internet Config in Mac OS X, perhaps to maintain backward compatibility for your application with Mac OS 8 and 9, here are some ways to optimize performance.
Getting multiple preferences at once.
Your program may access several Internet Config preferences within a single operation. For example, an FTP program on startup might always get the kICFTPHost, kICFTPProxyHost, kICFTPProxyAccount, kICFTPProxyPassword, and kICFTPProxyUser preferences. Bracket such a sequence of ICGetPref calls with an ICBegin and ICEnd function pair for significantly faster performance.
Calling Internet Config less often.
Your application can cache Internet Config preference data and then watch for changes using one of the preference coherency strategies described in the developer’s online documentation:
http://www.quinn.echidna.id.au/Quinn/Config/Prog_Docs.html#PreferenceCoherency
Using preferences from underlying frameworks.
Starting with Mac OS X, Internet Config is no longer the final authority on Internet preferences. For example, Launch Services stores URL helper application settings, and System Configuration stores the various proxy settings. When called by an application, Internet Config must call through to the appropriate underlying framework. Call Launch Services and System Configuration directly to improve performance.
The Mac OS 8 and 9 implementation of Internet Config is in the public domain, and Carbon supports all of its commonly-used functions. Functions that are not compatible with preemptive threads are not supported, and Internet Config no longer supports multiple configuration files. This document contains information on replacement functions.
For more information on Internet Config see its developer’s web site:
http://www.quinn.echidna.id.au/Quinn/Config
These functions let you create, configure, and destroy connections to Internet Config, denoted by the ICInstance
type. Although it is usual to create one connection when your program starts and destroy it when it terminates, you can create an arbitrary number of connections at any time.
These routines are not always required because the commonly used reading and writing calls perform this operation automatically. However, even in that case, these routines are useful if you are making repeated calls because they allow those calls to work faster.
You must call ICBegin
before calling any of these routines.
We recommend that you do not provide a user interface for editing Internet Config preferences from within your application. In Mac OS X, simply provide a way for the user to open the Internet pane of System Preferences. The ICEditPreferences
function provides support for this.
Internet Config’s high-level functions are suitable for applications that want to easily look up a file type and creator based on an extension, or vice versa. These functions are significantly slower than their lower level counterparts, especially if you call them repeatedly.
These functions are useful if you are doing multiple searches because they avoid the overhead of accessing the mappings database each time.
Internet Config’s low-level functions give you access to the primitive operations used to implement the other mapping functions.
ICGetCurrentProfile
ICSetCurrentProfile
ICCountProfiles
ICGetIndProfile
ICGetProfileName
ICSetProfileName
ICAddProfile
ICDeleteProfile
ICCSetPref
ICCAddMapEntry
ICCAddProfile
ICCBegin
ICCChooseConfig
ICCChooseNewConfig
ICCCountMapEntries
ICCCountPref
ICCCountProfiles
ICCCreateGURLEvent
ICCDefaultFileName
ICCDeleteMapEntry
ICCDeletePref
ICCDeleteProfile
ICCEditPreferences
ICCEnd
ICCFindConfigFile
ICCFindPrefHandle
ICCFindUserConfigFile
ICCGeneralFindConfigFile
ICCGetComponentInstance
ICCGetConfigName
ICCGetConfigReference
ICCGetCurrentProfile
ICCGetDefaultPref
ICCGetIndMapEntry
ICCGetIndPref
ICCGetIndProfile
ICCGetMapEntry
ICCGetMappingInterruptSafe
ICCGetPerm
ICCGetPref
ICCGetPrefHandle
ICCGetProfileName
ICCGetSeed
ICCGetSeedInterruptSafe
ICCGetVersion
ICChooseConfig
ICChooseNewConfig
ICCLaunchURL
ICCMapEntriesFilename
ICCMapEntriesTypeCreator
ICCMapFilename
ICCMapTypeCreator
ICCParseURL
ICCRefreshCaches
ICCRequiresInterruptSafe
ICCSendGURLEvent
ICCSetConfigReference
ICCSetCurrentProfile
ICCSetMapEntry
ICCSetPrefHandle
ICCSetProfileName
ICCSpecifyConfigFile
ICCStart
ICCStop
ICDefaultFileName
ICFindConfigFile
ICFindUserConfigFile
ICGeneralFindConfigFile
ICGetComponentInstance
ICGetConfigReference
ICGetMappingInterruptSafe
ICGetSeedInterruptSafe
ICRefreshCaches
ICRequiresInterruptSafe
ICSetConfigReference
ICSpecifyConfigFile
Adds an entry to the mappings database.
OSStatus ICAddMapEntry ( ICInstance inst, Handle entries, const ICMapEntry *entry );
A result code. See “Result Codes.”
InternetConfig.h
Creates a new profile and returns its ID.
OSStatus ICAddProfile ( ICInstance inst, ICProfileID prototypeID, ICProfileID *newID );
A result code. See “Result Codes.”
InternetConfig.h
Prepares Internet Config to read (and, optionally, to write) preferences.
OSStatus ICBegin ( ICInstance inst, ICPerm perm );
A result code. See “Result Codes.”
InternetConfig.h
Unsupported
OSStatus ICCAddMapEntry ( ComponentInstance inst, Handle entries, ICMapEntry *entry );
Use ICAddMapEntry
instead.
InternetConfig.h
Unsupported
OSStatus ICCAddProfile ( ComponentInstance inst, ICProfileID prototypeID, ICProfileID *newID );
Use ICAddProfile
instead.
InternetConfig.h
Unsupported
OSStatus ICCBegin ( ComponentInstance inst, ICPerm perm );
Use ICBegin
instead.
InternetConfig.h
Unsupported
OSStatus ICCChooseConfig ( ComponentInstance inst );
Because Internet Config no longer supports multiple configuration files, this function is obsolete, and there is no replacement function.
InternetConfig.h
Unsupported
OSStatus ICCChooseNewConfig ( ComponentInstance inst );
Because Internet Config no longer supports multiple configuration files, this function is obsolete, and there is no replacement function.
InternetConfig.h
Unsupported
OSStatus ICCCountMapEntries ( ComponentInstance inst, Handle entries, SInt32 *count );
Use ICCountMapEntries
instead.
InternetConfig.h
Unsupported
OSStatus ICCCountPref ( ComponentInstance inst, SInt32 *count );
Use ICCountPref
instead.
InternetConfig.h
Unsupported
OSStatus ICCCountProfiles ( ComponentInstance inst, SInt32 *count );
Use ICCountProfiles
instead.
InternetConfig.h
Unsupported
OSStatus ICCCreateGURLEvent ( ComponentInstance inst, OSType helperCreator, Handle urlH, AppleEvent *theEvent );
Use ICCreateGURLEvent
instead.
InternetConfig.h
Unsupported
OSStatus ICCDefaultFileName ( ComponentInstance inst, Str63 name );
Functions related to finding different IC database files are obsolete. You can simply remove these calls from your code—there are no replacement functions.
InternetConfig.h
Unsupported
OSStatus ICCDeleteMapEntry ( ComponentInstance inst, Handle entries, SInt32 pos );
Use ICDeleteMapEntry
instead.
InternetConfig.h
Unsupported
OSStatus ICCDeletePref ( ComponentInstance inst, ConstStr255Param key );
Use ICDeletePref
instead.
InternetConfig.h
Unsupported
OSStatus ICCDeleteProfile ( ComponentInstance inst, ICProfileID thisID );
Use ICDeleteProfile
instead.
InternetConfig.h
Unsupported
OSStatus ICCEditPreferences ( ComponentInstance inst, ConstStr255Param key );
Use ICEditPreferences
instead.
InternetConfig.h
Unsupported
OSStatus ICCEnd ( ComponentInstance inst );
Use ICEnd
instead.
InternetConfig.h
Unsupported
OSStatus ICCFindConfigFile ( ComponentInstance inst, SInt16 count, ICDirSpecArrayPtr folders );
Functions related to finding different IC database files are obsolete. You can simply remove these calls from your code—there are no replacement functions.
InternetConfig.h
Unsupported
OSStatus ICCFindPrefHandle ( ComponentInstance inst, ConstStr255Param key, ICAttr *attr, Handle prefh );
Use ICFindPrefHandle
instead.
InternetConfig.h
Unsupported
OSStatus ICCFindUserConfigFile ( ComponentInstance inst, ICDirSpec *where );
Functions related to finding different IC database files are obsolete. You can simply remove these calls from your code—there are no replacement functions.
InternetConfig.h
Unsupported
OSStatus ICCGeneralFindConfigFile ( ComponentInstance inst, Boolean searchPrefs, Boolean canCreate, SInt16 count, ICDirSpecArrayPtr folders );
Functions related to finding different IC database files are obsolete. You can simply remove these calls from your code—there are no replacement functions.
InternetConfig.h
Unsupported
OSStatus ICCGetComponentInstance ( ComponentInstance inst, ComponentInstance *componentInst );
Because Internet Config is not component-based under Mac OS X, use ICGetVersion
instead.
InternetConfig.h
Unsupported
OSStatus ICCGetConfigName ( ComponentInstance inst, Boolean longname, Str255 name );
Use ICGetConfigName
instead.
InternetConfig.h
Unsupported
OSStatus ICCGetConfigReference ( ComponentInstance inst, ICConfigRefHandle ref );
Because Internet Config no longer supports multiple configuration files, this function is obsolete, and there is no replacement function.
InternetConfig.h
Unsupported
OSStatus ICCGetCurrentProfile ( ComponentInstance inst, ICProfileID *currentID );
Use ICGetCurrentProfile
instead.
InternetConfig.h
Unsupported
OSStatus ICCGetDefaultPref ( ComponentInstance inst, ConstStr255Param key, Handle prefH );
Use ICGetDefaultPref
instead.
InternetConfig.h
Unsupported
OSStatus ICCGetIndMapEntry ( ComponentInstance inst, Handle entries, SInt32 index, SInt32 *pos, ICMapEntry *entry );
Use ICGetIndMapEntry
instead.
InternetConfig.h
Unsupported
OSStatus ICCGetIndPref ( ComponentInstance inst, SInt32 index, Str255 key );
Use ICGetIndPref
instead.
InternetConfig.h
Unsupported
OSStatus ICCGetIndProfile ( ComponentInstance inst, SInt32 index, ICProfileID *thisID );
Use ICGetIndProfile
instead.
InternetConfig.h
Unsupported
OSStatus ICCGetMapEntry ( ComponentInstance inst, Handle entries, SInt32 pos, ICMapEntry *entry );
Use ICGetMapEntry
instead.
InternetConfig.h
Unsupported
OSStatus ICCGetMappingInterruptSafe ( ComponentInstance inst, Ptr *mappingPref, SInt32 *mappingPrefSize );
ICCGetMappingInterruptSafe
is not compatible with preemptive threads. If your application relies on this API, contact Apple Developer Technical Support.
InternetConfig.h
Unsupported
OSStatus ICCGetPerm ( ComponentInstance inst, ICPerm *perm );
Use ICGetPerm
instead.
InternetConfig.h
Unsupported
OSStatus ICCGetPref ( ComponentInstance inst, ConstStr255Param key, ICAttr *attr, Ptr buf, SInt32 *size );
Use ICGetPref
instead.
InternetConfig.h
Unsupported
OSStatus ICCGetPrefHandle ( ComponentInstance inst, ConstStr255Param key, ICAttr *attr, Handle *prefh );
Use ICFindPrefHandle
instead.
InternetConfig.h
Unsupported
OSStatus ICCGetProfileName ( ComponentInstance inst, ICProfileID thisID, Str255 name );
Use ICGetProfileName
instead.
InternetConfig.h
Unsupported
OSStatus ICCGetSeed ( ComponentInstance inst, SInt32 *seed );
Use ICGetSeed
instead.
InternetConfig.h
Unsupported
OSStatus ICCGetSeedInterruptSafe ( ComponentInstance inst, SInt32 *seed );
ICCGetSeedInterruptSafe
is not compatible with preemptive threads. If your application relies on this API, contact Apple Developer Technical Support.
InternetConfig.h
Unsupported
OSStatus ICCGetVersion ( ComponentInstance inst, SInt32 whichVersion, UInt32 *version );
Use ICGetVersion
instead.
InternetConfig.h
Unsupported
OSStatus ICChooseConfig ( ICInstance inst );
Because Internet Config no longer supports multiple configuration files, this function is obsolete, and there is no replacement function.
InternetConfig.h
Unsupported
OSStatus ICChooseNewConfig ( ICInstance inst );
Because Internet Config no longer supports multiple configuration files, this function is obsolete, and there is no replacement function.
InternetConfig.h
Unsupported
OSStatus ICCLaunchURL ( ComponentInstance inst, ConstStr255Param hint, Ptr data, SInt32 len, SInt32 *selStart, SInt32 *selEnd );
Use ICLaunchURL
instead.
InternetConfig.h
Unsupported
OSStatus ICCMapEntriesFilename ( ComponentInstance inst, Handle entries, ConstStr255Param filename, ICMapEntry *entry );
Use ICMapEntriesFilename
instead.
InternetConfig.h
Unsupported
OSStatus ICCMapEntriesTypeCreator ( ComponentInstance inst, Handle entries, OSType fType, OSType fCreator, ConstStr255Param filename, ICMapEntry *entry );
Use ICMapEntriesTypeCreator
instead.
InternetConfig.h
Unsupported
OSStatus ICCMapFilename ( ComponentInstance inst, ConstStr255Param filename, ICMapEntry *entry );
Use ICMapFilename
instead.
InternetConfig.h
Unsupported
OSStatus ICCMapTypeCreator ( ComponentInstance inst, OSType fType, OSType fCreator, ConstStr255Param filename, ICMapEntry *entry );
Use ICMapTypeCreator
instead.
InternetConfig.h
Counts the number of entries in the mappings database preference provided.
OSStatus ICCountMapEntries ( ICInstance inst, Handle entries, long *count );
A result code. See “Result Codes.”
InternetConfig.h
Returns the total number of preferences available.
OSStatus ICCountPref ( ICInstance inst, long *count );
A result code. See “Result Codes.”
InternetConfig.h
Returns the number of available profiles.
OSStatus ICCountProfiles ( ICInstance inst, long *count );
A result code. See “Result Codes.”
InternetConfig.h
Unsupported
OSStatus ICCParseURL ( ComponentInstance inst, ConstStr255Param hint, Ptr data, SInt32 len, SInt32 *selStart, SInt32 *selEnd, Handle url );
Use ICParseURL
instead.
InternetConfig.h
Creates a GURL Apple event, targetted at the application with the specified creator code
OSStatus ICCreateGURLEvent ( ICInstance inst, OSType helperCreator, Handle urlH, AppleEvent *theEvent );
A result code. See “Result Codes.”
InternetConfig.h
Unsupported
OSStatus ICCRefreshCaches ( ComponentInstance inst );
This function is obsolete, because there is no supported way to modify the Internet Config database without going through the Internet Config API. There is no replacement function.
InternetConfig.h
Unsupported
OSStatus ICCRequiresInterruptSafe ( ComponentInstance inst );
This function is not compatible with preemptive threads. There is no replacement.
InternetConfig.h
Unsupported
OSStatus ICCSendGURLEvent ( ComponentInstance inst, AppleEvent *theEvent );
Use ICSendGURLEvent
instead.
InternetConfig.h
Unsupported
OSStatus ICCSetConfigReference ( ComponentInstance inst, ICConfigRefHandle ref, SInt32 flags );
Because Internet Config no longer supports multiple configuration files, this function is obsolete, and there is no replacement function.
InternetConfig.h
Unsupported
OSStatus ICCSetCurrentProfile ( ComponentInstance inst, ICProfileID newID );
Use ICSetCurrentProfile
instead.
InternetConfig.h
Unsupported
OSStatus ICCSetMapEntry ( ComponentInstance inst, Handle entries, SInt32 pos, ICMapEntry *entry );
Use ICSetMapEntry
ICSetMapEntry
instead.
InternetConfig.h
Unsupported
OSStatus ICCSetPref ( ComponentInstance inst, ConstStr255Param key, ICAttr attr, Ptr buf, SInt32 size );
Use ICSetPref
instead.
InternetConfig.h
Unsupported
OSStatus ICCSetPrefHandle ( ComponentInstance inst, ConstStr255Param key, ICAttr attr, Handle prefh );
Use ICSetPrefHandle
instead.
InternetConfig.h
Unsupported
OSStatus ICCSetProfileName ( ComponentInstance inst, ICProfileID thisID, ConstStr255Param name );
Use ICSetProfileName
instead.
InternetConfig.h
Unsupported
OSStatus ICCSpecifyConfigFile ( ComponentInstance inst, FSSpec *config );
Functions related to finding different IC database files are obsolete. You can simply remove these calls from your code—there are no replacement functions.
InternetConfig.h
Unsupported
OSStatus ICCStart ( ComponentInstance *inst, OSType creator );
Use ICStart
instead.
InternetConfig.h
Unsupported
OSStatus ICCStop ( ComponentInstance inst );
Use ICStop
instead.
InternetConfig.h
Unsupported
OSStatus ICDefaultFileName ( ICInstance inst, Str63 name );
Functions related to finding different IC database files are obsolete. You can simply remove these calls from your code—there are no replacement functions.
InternetConfig.h
Deletes an entry in the specified Mapping preference.
OSStatus ICDeleteMapEntry ( ICInstance inst, Handle entries, long pos );
A result code. See “Result Codes.”
InternetConfig.h
Deletes the preference for the specified key.
OSStatus ICDeletePref ( ICInstance inst, ConstStr255Param key );
A result code. See “Result Codes.”
InternetConfig.h
Deletes the profile that has the specified ID.
OSStatus ICDeleteProfile ( ICInstance inst, ICProfileID thisID );
A result code. See “Result Codes.”
InternetConfig.h
Opens the Internet pane of System Preferences.
OSStatus ICEditPreferences ( ICInstance inst, ConstStr255Param key );
A result code. See “Result Codes.”
This function launches the Internet preference control appropriate to the operating system version. In Mac OS X, it opens the Internet pane of System Preferences. In Mac OS 8 and 9 wiith Carbon, it launches the Internet control panel. On earlier systems, it launches Internet Config.
InternetConfig.h
Tells Internet Config that you have finished accessing preference information.
OSStatus ICEnd ( ICInstance inst );
A result code. See “Result Codes.”
InternetConfig.h
Unsupported
OSStatus ICFindConfigFile ( ICInstance inst, SInt16 count, ICDirSpecArrayPtr folders );
Functions related to finding different IC database files are obsolete. You can simply remove these calls from your code—there are no replacement functions.
InternetConfig.h
Gets a preference’s data, like ICGetPref
, but returns the data in a handle.
OSStatus ICFindPrefHandle ( ICInstance inst, ConstStr255Param key, ICAttr *attr, Handle prefh );
A result code. See “Result Codes.”
InternetConfig.h
Unsupported
OSStatus ICFindUserConfigFile ( ICInstance inst, ICDirSpec *where );
Functions related to finding different IC database files are obsolete. You can simply remove these calls from your code—there are no replacement functions.
InternetConfig.h
Unsupported
OSStatus ICGeneralFindConfigFile ( ICInstance inst, Boolean searchPrefs, Boolean canCreate, SInt16 count, ICDirSpecArrayPtr folders );
Functions related to finding different IC database files are obsolete. You can simply remove these calls from your code—there are no replacement functions.
InternetConfig.h
Unsupported
OSStatus ICGetComponentInstance ( ICInstance inst, ComponentInstance *componentInst );
Because Internet Config is not component-based under X, use ICGetVersion
instead of ICGetComponentInstance
.
InternetConfig.h
Returns a displayable string that represents the instance’s current configuration.
OSStatus ICGetConfigName ( ICInstance inst, Boolean longname, Str255 name );
A result code. See “Result Codes.”
InternetConfig.h
Unsupported
OSStatus ICGetConfigReference ( ICInstance inst, ICConfigRefHandle ref );
Because Internet Config no longer supports multiple configuration files, this function is obsolete, and there is no replacement function.
InternetConfig.h
Returns the profile ID of the current profile.
OSStatus ICGetCurrentProfile ( ICInstance inst, ICProfileID *currentID );
A result code. See “Result Codes.”
InternetConfig.h
Gets the default value for the preference associated with the specified key.
OSStatus ICGetDefaultPref ( ICInstance inst, ConstStr255Param key, Handle prefH );
A result code. See “Result Codes.”
InternetConfig.h
Returns the mappings database entry for a specified index .
OSStatus ICGetIndMapEntry ( ICInstance inst, Handle entries, long index, long *pos, ICMapEntry *entry );
A result code. See “Result Codes.”
InternetConfig.h
Returns the key associated with the preference at the specified index.
OSStatus ICGetIndPref ( ICInstance inst, long index, Str255 key );
A result code. See “Result Codes.”
InternetConfig.h
Returns the ID of the profile at the specified index.
OSStatus ICGetIndProfile ( ICInstance inst, long index, ICProfileID *thisID );
A result code. See “Result Codes.”
InternetConfig.h
Returns a mappings database entry based on its position in the Mapping preference.
OSStatus ICGetMapEntry ( ICInstance inst, Handle entries, long pos, ICMapEntry *entry );
A result code. See “Result Codes.”
InternetConfig.h
Unsupported
OSStatus ICGetMappingInterruptSafe ( ICInstance inst, Ptr *mappingPref, SInt32 *mappingPrefSize );
Because ICGetMappingInterruptSafe
is not compatible with preemptive threads, it has been removed from Carbon.
InternetConfig.h
Returns the current permissions for this instance, i.e. the permission value you used when you called ICBegin
, or returns ioNoPerm
if you haven’t call ICBegin
.
OSStatus ICGetPerm ( ICInstance inst, ICPerm *perm );
A result code. See “Result Codes.”
InternetConfig.h
Given a preference’s key, gets the preference’s data and places it into a buffer that you supply.
OSStatus ICGetPref ( ICInstance inst, ConstStr255Param key, ICAttr *attr, void *buf, long *size );
A result code. See “Result Codes.”
InternetConfig.h
Deprecated. While this function works in Mac OS X, you should use ICFindPrefHandle instead.
OSStatus ICGetPrefHandle ( ICInstance inst, ConstStr255Param key, ICAttr *attr, Handle *prefh );
A result code. See “Result Codes.”
InternetConfig.h
Returns the name of the profile that has the specified ID.
OSStatus ICGetProfileName ( ICInstance inst, ICProfileID thisID, Str255 name );
A result code. See “Result Codes.”
InternetConfig.h
Returns the seed for the current preferences set.
OSStatus ICGetSeed ( ICInstance inst, long *seed );
A result code. See “Result Codes.”
InternetConfig.h
Unsupported
OSStatus ICGetSeedInterruptSafe ( ICInstance inst, SInt32 *seed );
Because ICGetSeedInterruptSafe
is not compatible with preemptive threads, it has been removed from Carbon.
InternetConfig.h
Returns the version of Internet Config installed on the system.
OSStatus ICGetVersion ( ICInstance inst, long whichVersion, UInt32 *version );
A result code. See “Result Codes.”
For the range of versions, refer to “Version Constants.”
InternetConfig.h
Parses a URL out of the specified text and feeds it to the appropriate helper application.
OSStatus ICLaunchURL ( ICInstance inst, ConstStr255Param hint, const void *data, long len, long *selStart, long *selEnd );
A result code. See “Result Codes.”
InternetConfig.h
Given a filename, returns the most appropriate ICMapEntry
based on the filename extension—without the overhead of a mappings database access.
OSStatus ICMapEntriesFilename ( ICInstance inst, Handle entries, ConstStr255Param filename, ICMapEntry *entry );
A result code. See “Result Codes.”
InternetConfig.h
Given a file type and creator (and optionally a filename), returns the most appropriate ICMapEntry
—without the overhead of a mappings database access.
OSStatus ICMapEntriesTypeCreator ( ICInstance inst, Handle entries, OSType fType, OSType fCreator, ConstStr255Param filename, ICMapEntry *entry );
A result code. See “Result Codes.”
InternetConfig.h
Given a filename, returns the most appropriate ICMapEntry
based on the filename extension.
OSStatus ICMapFilename ( ICInstance inst, ConstStr255Param filename, ICMapEntry *entry );
A result code. See “Result Codes.”
InternetConfig.h
Given a file type and creator (and optionally a filename), returns the most appropriate ICMapEntry
.
OSStatus ICMapTypeCreator ( ICInstance inst, OSType fType, OSType fCreator, ConstStr255Param filename, ICMapEntry *entry );
A result code. See “Result Codes.”
InternetConfig.h
Parses a URL out of the specified text and returns it to the calling program.
OSStatus ICParseURL ( ICInstance inst, ConstStr255Param hint, const void *data, long len, long *selStart, long *selEnd, Handle url );
A result code. See “Result Codes.”
InternetConfig.h
Unsupported
OSStatus ICRefreshCaches ( ICInstance inst );
This function ICRefreshCaches
is obsolete. There is no supported way to modify the Internet Config database without going through the Internet Config API. There is no replacement function.
InternetConfig.h
Unsupported
OSStatus ICRequiresInterruptSafe ( ICInstance inst );
Because ICRequiresInterruptSafe
is not compatible with preemptive threads, it has been removed from Carbon.
InternetConfig.h
Sends a specified Apple Event to the target application.
OSStatus ICSendGURLEvent ( ICInstance inst, AppleEvent *theEvent );
A result code. See “Result Codes.”
InternetConfig.h
Unsupported
OSStatus ICSetConfigReference ( ICInstance inst, ICConfigRefHandle ref, SInt32 flags );
Because Internet Config no longer supports multiple configuration files, this function is obsolete, and there is no replacement function.
InternetConfig.h
Sets the current profile to a specified profile ID.
OSStatus ICSetCurrentProfile ( ICInstance inst, ICProfileID newID );
A result code. See “Result Codes.”
InternetConfig.h
Sets an entry in a specified Mapping preference.
OSStatus ICSetMapEntry ( ICInstance inst, Handle entries, long pos, const ICMapEntry *entry );
A result code. See “Result Codes.”
InternetConfig.h
Sets a preference given its key, attributes, and a buffer containing the preference data.
OSStatus ICSetPref ( ICInstance inst, ConstStr255Param key, ICAttr attr, const void *buf, long size );
A result code. See “Result Codes.”
InternetConfig.h
Sets a preference, like ICSetPref
, but takes its input as a handle.
OSStatus ICSetPrefHandle ( ICInstance inst, ConstStr255Param key, ICAttr attr, Handle prefh );
A result code. See “Result Codes.”
InternetConfig.h
Sets the name of the profile that has the specified ID.
OSStatus ICSetProfileName ( ICInstance inst, ICProfileID thisID, ConstStr255Param name );
A result code. See “Result Codes.”
InternetConfig.h
Unsupported
OSStatus ICSpecifyConfigFile ( ICInstance inst, FSSpec *config );
Functions related to finding different IC database files are obsolete. You can simply remove these calls from your code—there are no replacement functions.
InternetConfig.h
Call this routine to start using Internet Config—typically at application initialization time—passing it your program’s creator code.
OSStatus ICStart ( ICInstance *inst, OSType signature );
A result code. See “Result Codes.”
InternetConfig.h
Call this when your application is done using Internet Config, passing it the instance you got from ICStart
.
OSStatus ICStop ( ICInstance inst );
A result code. See “Result Codes.”
InternetConfig.h
A fixed length record used to specify an application.
struct ICAppSpec { OSType fCreator; Str63 name; }; typedef struct ICAppSpec ICAppSpec; typedef ICAppSpec * ICAppSpecPtr; typedef ICAppSpecPtr * ICAppSpecHandle;
The program using this specification is expected to look up the location of the application in the desktop database. The name is provided to display to the user, and should not affect the search.
InternetConfig.h
Represents a list of application specifications.
struct ICAppSpecList { short numberOfItems; ICAppSpec appSpecs[1]; }; typedef struct ICAppSpecList ICAppSpecList; typedef ICAppSpecList * ICAppSpecListPtr; typedef ICAppSpecListPtr * ICAppSpecListHandle;
InternetConfig.h
Specifies a mapping from MacRoman encoding (kTextEncodingMacRoman) to Mac Net ASCII (kTextEncodingMacRomanLatin1) and vice versa.
struct ICCharTable { unsigned char netToMac[256]; unsigned char macToNet[256]; }; typedef struct ICCharTable ICCharTable; typedef ICCharTable * ICCharTablePtr; typedef ICCharTablePtr * ICCharTableHandle;
InternetConfig.h
Stores a permanent reference to an Internet Config configuration.
struct ICConfigRef { OSType manufacturer; }; typedef struct ICConfigRef ICConfigRef; typedef ICConfigRef * ICConfigRefPtr; typedef ICConfigRefPtr * ICConfigRefHandle;
The ICConfigRef
type varies in length and only the first four bytes, representing the manufacturer field, has a public meaning. For more information see the IC Internals Documentation.
InternetConfig.h
Holds the vRefNum
and dirID
of a directory.
struct ICDirSpec { short vRefNum; long dirID; }; typedef struct ICDirSpec ICDirSpec; typedef ICDirSpec ICDirSpecArray[4]; typedef ICDirSpecArray * ICDirSpecArrayPtr;
An array of ICDirSpec
records is supplied to the pre-Carbon-only function ICFindConfigFile
to specify the search path. This array is defined to contain just 4 elements, but is in fact arbitrarily extensible.
InternetConfig.h
Used for all error results from Internet Config.
typedef long ICError;
ICError uses a long integer because Internet Config makes calls to Component Manager, which uses long integers for error codes.
This data type is available only if you define OLDROUTINENAMES
.
InternetConfig.h
Defines the format of a key.
struct ICFileInfo { OSType fType; OSType fCreator; Str63 name; }; typedef struct ICFileInfo ICFileInfo; typedef ICFileInfo * ICFileInfoPtr; typedef ICFileInfoPtr * ICFileInfoHandle;
This data type defines the format of a key. That key data type has previouisly been removed from the header file. ICFileInfo
is deprecated and will also be removed, but for the moment, it is available if you define OLDROUTINENAMES
.
InternetConfig.h
A variable length data structure used to specify a file or folder.
struct ICFileSpec { Str31 volName; long volCreationDate; FSSpec fss; AliasRecord alias; }; typedef struct ICFileSpec ICFileSpec; typedef ICFileSpec * ICFileSpecPtr; typedef ICFileSpecPtr * ICFileSpecHandle;
ICFileSpec
contains both an alias and a ‘poor man’s alias.’ All modern applications can use the real alias and ignore the poor man’s alias. The latter was included so that programs running under System 6 could specify file positions using vol_name
and vol_creation_date
for the volume, fss.parID
for the directory on the volume, and fss.name
for the file in the directory.
InternetConfig.h
A fixed length record used to specify a font, size and face.
struct ICFontRecord { short size; Style face; char pad; Str255 font; }; typedef struct ICFontRecord ICFontRecord; typedef ICFontRecord * ICFontRecordPtr; typedef ICFontRecordPtr * ICFontRecordHandle;
InternetConfig.h
An opaque type used to hold a reference to a session with Internet Config.
typedef struct OpaqueICInstance * ICInstance;
Applications can create IC instances by calling ICStart
, use them with any of the API routines, and destroy them by calling ICStop
.
An ICInstance
is a pointer, so you can use the system nil
value to denote an invalid instance. Do not pass an ICInstance
between processes. Also, do not pass an ICInstance
between instruction set architectures, i.e. from PowerPC to 68K or vice versa.
InternetConfig.h
Specifies an Internet Config map entry.
struct ICMapEntry { short totalLength; ICFixedLength fixedLength; short version; OSType fileType; OSType fileCreator; OSType postCreator; ICMapEntryFlags flags; Str255 extension; Str255 creatorAppName; Str255 postAppName; Str255 MIMEType; Str255 entryName; }; typedef struct ICMapEntry ICMapEntry; typedef ICMapEntry * ICMapEntryPtr; typedef ICMapEntryPtr * ICMapEntryHandle;
totalLength
The length of the map entry, in bytes, from beginning of the record. This includes the fixed length, the length of the packed Pascal strings at the end of the entry, and the length of the user data that follow those strings.
fixedLength
The length of the fixed part of the map entry, in bytes, from beginning of the record.
version
The version number of the map entry. The only version currently defined is 0.
fileType
The four-character file type for the map entry.
fileCreator
The four-character creator code for the map entry.
postCreator
The creator code for the post-processing application for the map entry. Applications should consult this field only if the ICmap_post_bit
is set in the flags
field, but even if that bit is not set, applications can determine the post-processing application by looking at this field. If no post processing application has even been set, this field’s value will be 0.
flags
Flags associated with this map entry. For flag definitions, see “Map Constants,” “Map Entry Flags,” and “Map Entry Masks.”
extension
The filename extension for this map entry.
creatorAppName
The name of the creator application identified by the fileCreator
field. You can use this field to display the application name even if the application is not installed.
postAppName
The name of the post-processing application identified by the postCreator
field. You can use this field to display the post-processing application’s name even if the that application is not installed. See the post_creator
field description for details as to when this field is valid.
MIMEType
The MIME type for the map entry, for example, “application/zip”.
entryName
The user-visible name for the map entry.
The value of the Mappings preference is not an array, so you cannot index it directly. It is instead a packed array of ICMapEntry
types, with each entry packed to remove the empty space at the end of the strings. Entries can start on an odd address and entries can contain user data . We strongly recommend that you access this data structure using the routines described in this section. These routines return an unpacked ICMapEntry
, which is a lot easier to deal with.
Each ICMapEntry
data type provides a filename extension, a MIME type, and a file type and creator. The database of ICMapEntry
types is not normalised; that is, there can be multiple entries with the same creator, file type, MIME type, filename extension, and so on. In general, each application determines how these entries are used in a particular circumstance, although IC does define some policies by way of its high level mapping routines.
InternetConfig.h
Specifies an Internet Config TCP service entry.
struct ICServiceEntry { Str255 name; short port; ICServiceEntryFlags flags; }; typedef struct ICServiceEntry ICServiceEntry; typedef ICServiceEntry * ICServiceEntryPtr; typedef ICServiceEntryPtr * ICServiceEntryHandle;
name
The name for the TCP service entry.
port
The port for the TCP service entry.
flags
For descriptions of the flags, see “Services Constants,” “Services Bits,” and “Services Masks.”
InternetConfig.h
Specifies the mapping between TCP service names and their ports.
struct ICServices { short count; ICServiceEntry services[1]; }; typedef struct ICServices ICServices; typedef ICServices * ICServicesPtr; typedef ICServicesPtr * ICServicesHandle;
count
services
An unbounded array of ICServiceEntry
records.
InternetConfig.h
typedef ComponentInstance internetConfigurationComponent;
This data type is obsolete. Use the data type ICInstance
instead.
InternetConfig.h
enum { kInternetEventClass = 'GURL', kAEGetURL = 'GURL', kAEFetchURL = 'FURL', keyAEAttaching = 'Atch' };
These are old names, mapped to newer names for backward compatibility, available only if you define OLDROUTINENAMES
.
enum { ICattr_no_change = (unsigned long) (kICAttrNoChange), ICattr_locked_bit = kICAttrLockedBit, ICattr_locked_mask = kICAttrLockedMask, ICattr_volatile_bit = kICAttrVolatileBit, ICattr_volatile_mask = kICAttrVolatileMask, icNoUserInteraction_bit = kICNoUserInteractionBit, icNoUserInteraction_mask = kICNoUserInteractionMask, ICfiletype = kICFileType, ICcreator = kICCreator };
Define the component type, subtype, and manufacturer of the Internet Config component.
enum { kICComponentType = 'PREF', kICComponentSubType = 'ICAp', kICComponentManufacturer = 'JPQE' };
enum { internetConfigurationComponentType = 'PREF', internetConfigurationComponentSubType = 'ICAp', internetConfigurationComponentInterfaceVersion0 = 0x00000000, internetConfigurationComponentInterfaceVersion1 = 0x00010000, internetConfigurationComponentInterfaceVersion2 = 0x00020000, internetConfigurationComponentInterfaceVersion3 = 0x00030000, internetConfigurationComponentInterfaceVersion = internetConfigurationComponentInterfaceVersion3 };
These constants are deprecated. Please use Component Interface Version
and Component Identifiers
instead.
Define the possible version numbers returned by the Internet Config component.
enum { kICComponentInterfaceVersion0 = 0x00000000, kICComponentInterfaceVersion1 = 0x00010000, kICComponentInterfaceVersion2 = 0x00020000, kICComponentInterfaceVersion3 = 0x00030000, kICComponentInterfaceVersion4 = 0x00040000, kICComponentInterfaceVersion = kICComponentInterfaceVersion4 };
kICComponentInterfaceVersion0
Internet Config versions greater than or equal to 1.0.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICComponentInterfaceVersion1
Internet Config versions greater than or equal to 1.1.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICComponentInterfaceVersion2
Internet Config versions greater than or equal to 1.2.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICComponentInterfaceVersion3
Internet Config versions greater than or equal to 2.0.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICComponentInterfaceVersion4
Internet Config versions greater than or equal to 2.5.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICComponentInterfaceVersion
The current version number is 4.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
These constants define the possible version numbers returned by the Internet Config component in response to a ICGetVersion
call. The constants define only the high word of the version number, which is the version of the programming interface. The low word of the version number is the implementation version, which changes with each bug fix release of Internet Config.
Represent component selectors for each Internet Config function.
enum { kICCStart = 0, kICCStop = 1, kICCGetVersion = 50, kICCFindConfigFile = 2, kICCFindUserConfigFile = 14, kICCGeneralFindConfigFile = 30, kICCChooseConfig = 33, kICCChooseNewConfig = 34, kICCGetConfigName = 35, kICCGetConfigReference = 31, kICCSetConfigReference = 32, kICCSpecifyConfigFile = 3, kICCRefreshCaches = 47, kICCGetSeed = 4, kICCGetPerm = 13, kICCDefaultFileName = 11, kICCBegin = 5, kICCGetPref = 6, kICCSetPref = 7, kICCFindPrefHandle = 36, kICCGetPrefHandle = 26, kICCSetPrefHandle = 27, kICCCountPref = 8, kICCGetIndPref = 9, kICCDeletePref = 12, kICCEnd = 10, kICCGetDefaultPref = 49, kICCEditPreferences = 15, kICCLaunchURL = 17, kICCParseURL = 16, kICCCreateGURLEvent = 51, kICCSendGURLEvent = 52, kICCMapFilename = 24, kICCMapTypeCreator = 25, kICCMapEntriesFilename = 28, kICCMapEntriesTypeCreator = 29, kICCCountMapEntries = 18, kICCGetIndMapEntry = 19, kICCGetMapEntry = 20, kICCSetMapEntry = 21, kICCDeleteMapEntry = 22, kICCAddMapEntry = 23, kICCGetCurrentProfile = 37, kICCSetCurrentProfile = 38, kICCCountProfiles = 39, kICCGetIndProfile = 40, kICCGetProfileName = 41, kICCSetProfileName = 42, kICCAddProfile = 43, kICCDeleteProfile = 44, kICCRequiresInterruptSafe = 45, kICCGetMappingInterruptSafe = 46, kICCGetSeedInterruptSafe = 48, kICCFirstSelector = kICCStart, kICCLastSelector = 52 };
These constants are component selectors for each Internet Config fuction. You can use these values as parameters to the Component Manager’s ComponentFunctionImplemented
function. These are also useful for authors of override components.
enum { kICCStartProcInfo = 1008, kICCStopProcInfo = 240, kICCGetVersionProcInfo = 4080, kICCFindConfigFileProcInfo = 3824, kICCFindUserConfigFileProcInfo = 1008, kICCGeneralFindConfigFileProcInfo = 58864, kICCChooseConfigProcInfo = 240, kICCChooseNewConfigProcInfo = 240, kICCGetConfigNameProcInfo = 3568, kICCGetConfigReferenceProcInfo = 1008, kICCSetConfigReferenceProcInfo = 4080, kICCSpecifyConfigFileProcInfo = 1008, kICCRefreshCachesProcInfo = 240, kICCGetSeedProcInfo = 1008, kICCGetPermProcInfo = 1008, kICCDefaultFileNameProcInfo = 1008, kICCGetComponentInstanceProcInfo = 1008, kICCBeginProcInfo = 496, kICCGetPrefProcInfo = 65520, kICCSetPrefProcInfo = 65520, kICCFindPrefHandleProcInfo = 16368, kICCGetPrefHandleProcInfo = 16368, kICCSetPrefHandleProcInfo = 16368, kICCCountPrefProcInfo = 1008, kICCGetIndPrefProcInfo = 4080, kICCDeletePrefProcInfo = 1008, kICCEndProcInfo = 240, kICCGetDefaultPrefProcInfo = 4080, kICCEditPreferencesProcInfo = 1008, kICCLaunchURLProcInfo = 262128, kICCParseURLProcInfo = 1048560, kICCCreateGURLEventProcInfo = 16368, kICCSendGURLEventProcInfo = 1008, kICCMapFilenameProcInfo = 4080, kICCMapTypeCreatorProcInfo = 65520, kICCMapEntriesFilenameProcInfo = 16368, kICCMapEntriesTypeCreatorProcInfo = 262128, kICCCountMapEntriesProcInfo = 4080, kICCGetIndMapEntryProcInfo = 65520, kICCGetMapEntryProcInfo = 16368, kICCSetMapEntryProcInfo = 16368, kICCDeleteMapEntryProcInfo = 4080, kICCAddMapEntryProcInfo = 4080, kICCGetCurrentProfileProcInfo = 1008, kICCSetCurrentProfileProcInfo = 1008, kICCCountProfilesProcInfo = 1008, kICCGetIndProfileProcInfo = 4080, kICCGetProfileNameProcInfo = 4080, kICCSetProfileNameProcInfo = 4080, kICCAddProfileProcInfo = 4080, kICCDeleteProfileProcInfo = 1008, kICCRequiresInterruptSafeProcInfo = 240, kICCGetMappingInterruptSafeProcInfo = 4080, kICCGetSeedInterruptSafeProcInfo = 1008 };
Specify AppleEvent details for Internet Config preference requests.
enum { kICEditPreferenceEventClass = 'ICAp', kICEditPreferenceEvent = 'ICAp', keyICEditPreferenceDestination = 'dest' };
These constants specify details of the AppleEvent that the ICEditPreferences
function sends to the Internet Config application to request it to open the edit window for a specific preference. Consult the Internet Config terminology resource ('aete'
) for the meaning of these constants.
enum { kICFileSpecHeaderSize = sizeof(ICFileSpec) - sizeof(AliasRecord) };
enum { ICfile_spec_header_size = kICFileSpecHeaderSize };
This constant is available only if you define OLDROUTINENAMES
.
Define the file type and creator code for the Internet preferences file.
enum { kICFileType = 'ICAp', kICCreator = 'ICAp' };
kICFileType
The Finder file type for the Internet preferences file.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICCreator
The Finder creator code for the Internet preferences file.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
#define kICReservedKey "\pkICReservedKey" #define kICArchieAll "\pArchieAll" #define kICArchiePreferred "\pArchiePreferred" #define kICCharacterSet "\pCharacterSet" #define kICDocumentFont "\pDocumentFont" #define kICDownloadFolder "\pDownloadFolder" #define kICEmail "\pEmail" #define kICFTPHost "\pFTPHost" #define kICFTPProxyAccount "\pFTPProxyAccount" #define kICFTPProxyHost "\pFTPProxyHost" #define kICFTPProxyPassword "\pFTPProxyPassword" #define kICFTPProxyUser "\pFTPProxyUser" #define kICFingerHost "\pFingerHost" #define kICGopherHost "\pGopherHost" #define kICGopherProxy "\pGopherProxy" #define kICHTTPProxyHost "\pHTTPProxyHost" #define kICHelper "\pHelper•" #define kICHelperDesc "\pHelperDesc•" #define kICHelperList "\pHelperList•" #define kICIRCHost "\pIRCHost" #define kICInfoMacAll "\pInfoMacAll" #define kICInfoMacPreferred "\pInfoMacPreferred" #define kICLDAPSearchbase "\pLDAPSearchbase" #define kICLDAPServer "\pLDAPServer" #define kICListFont "\pListFont" #define kICMacSearchHost "\pMacSearchHost" #define kICMailAccount "\pMailAccount" #define kICMailHeaders "\pMailHeaders" #define kICMailPassword "\pMailPassword" #define kICMapping "\pMapping" #define kICNNTPHost "\pNNTPHost" #define kICNTPHost "\pNTPHost" #define kICNewMailDialog "\pNewMailDialog" #define kICNewMailFlashIcon "\pNewMailFlashIcon" #define kICNewMailPlaySound "\pNewMailPlaySound" #define kICNewMailSoundName "\pNewMailSoundName" #define kICNewsAuthPassword "\pNewsAuthPassword" #define kICNewsAuthUsername "\pNewsAuthUsername" #define kICNewsHeaders "\pNewsHeaders" #define kICNoProxyDomains "\pNoProxyDomains" #define kICOrganization "\pOrganization" #define kICPhHost "\pPhHost" #define kICPlan "\pPlan" #define kICPrinterFont "\pPrinterFont" #define kICQuotingString "\pQuotingString" #define kICRealName "\pRealName" #define kICRTSPProxyHost "\pRTSPProxyHost" #define kICSMTPHost "\pSMTPHost" #define kICScreenFont "\pScreenFont" #define kICServices "\pServices" #define kICSignature "\pSignature" #define kICSnailMailAddress "\pSnailMailAddress" #define kICSocksHost "\pSocksHost" #define kICTelnetHost "\pTelnetHost" #define kICUMichAll "\pUMichAll" #define kICUMichPreferred "\pUMichPreferred" #define kICUseFTPProxy "\pUseFTPProxy" #define kICUseGopherProxy "\pUseGopherProxy" #define kICUseHTTPProxy "\pUseHTTPProxy" #define kICUsePassiveFTP "\pUsePassiveFTP" #define kICUseRTSPProxy "\pUseRTSPProxy" #define kICUseSocks "\pUseSocks" #define kICWAISGateway "\pWAISGateway" #define kICWWWHomePage "\pWWWHomePage" #define kICWebBackgroundColour "\pWebBackgroundColour" #define kICWebReadColor "\p646F6777•WebReadColor" #define kICWebSearchPagePrefs "\pWebSearchPagePrefs" #define kICWebTextColor "\pWebTextColor" #define kICWebUnderlineLinks "\p646F6777•WebUnderlineLinks" #define kICWebUnreadColor "\p646F6777•WebUnreadColor" #define kICWhoisHost "\pWhoisHost"
kICReservedKey
Reserved for use by Internet Config.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICArchieAll
Formatted string list of Archie servers.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICArchiePreferred
Formatted string naming the preferred Archie server.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICCharacterSet
For conversion between kTextEncodingMacRoman (“Mac”) and kTextEncodingMacRomanLatin1 (“Net”). Deprecated. Use the Text Encoding Conversion manager and Unicode instead.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICDocumentFont
Font to use for proportional text.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICDownloadFolder
Location in the file system for newly downloaded files.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICEmail
Return address for the user.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICFTPHost
Default FTP server.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICFTPProxyAccount
Second-level FTP proxy authorization. Read-only in Mac OS X; use System Configuration to set this value.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICFTPProxyHost
Default FTP proxy server. Read-only in Mac OS X; use System Configuration to set this value.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICFTPProxyPassword
Password (scrambled) for FTP proxy user. Read-only in Mac OS X; use System Configuration to set this value.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICFTPProxyUser
First-level FTP proxy authorization. Read-only in Mac OS X; use System Configuration to set this value.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICFingerHost
Default finger-protocol server.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICGopherHost
Default gopher-protocol server.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICGopherProxy
Read-only in Mac OS X; use System Configuration to set this value.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICHTTPProxyHost
Default HTTP proxy server. Read-only in Mac OS X; use System Configuration to set this value.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICHelper
Helpers for URL schemes.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICHelperDesc
Descriptions for URL schemes.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICHelperList
Common helpers for URL schemes.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICIRCHost
Internet Relay Chat server.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICInfoMacAll
Formatted list of Info-Mac servers.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICInfoMacPreferred
Formatted string containing preferred Info-Mac server.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICLDAPSearchbase
Default LDAP search base.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICLDAPServer
Default LDAP server.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICListFont
Font used for lists, such as news article lists.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMacSearchHost
Host for MacSearch queries.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMailAccount
Account from which to fetch email.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMailHeaders
Additional headers for email messages.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMailPassword
Password (scrambled) for the default mail account.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMapping
File-type mapping.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICNNTPHost
Default NNTP server.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICNTPHost
Default NTP (Network Time Protocol) server.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICNewMailDialog
Boolean value indicating whether to display a new email dialog.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICNewMailFlashIcon
Boolean value indicating whether to flash a new email icon.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICNewMailPlaySound
Boolean value indicating whether to play a new email sound.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICNewMailSoundName
The name of the preferred new email sound.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICNewsAuthPassword
Password (scrambled) for authorized news account.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICNewsAuthUsername
User name for authorized news account.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICNewsHeaders
Additional headers for news messages.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICNoProxyDomains
List of domains not to be proxied.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICOrganization
String for the X-Organization MIME header.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICPhHost
Default Ph protocol server.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICPlan
Default response for finger servers.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICPrinterFont
Font used to print the monospaced text displayed on screen (see kICScreenFont).
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICQuotingString
A short string used to indicate quoting in email and news replies.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICRealName
Real name of user.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICRTSPProxyHost
Default RTSP proxy server. Read-only in Mac OS X; use System Configuration to set this value.
Available in Mac OS X v10.1 and later.
Declared in InternetConfig.h
.
kICSMTPHost
Default SMTP host.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICScreenFont
Font for monospaced text.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICServices
TCP and IP port-to-name mapping.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICSignature
Block of text to append to outgoing news and email messages.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICSnailMailAddress
Preferred postal mail address.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICSocksHost
Default SOCKS host. (The host.domain format allows ":port" and " port")
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICTelnetHost
Default Telnet host.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICUMichAll
Formatted list of UMich servers.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICUMichPreferred
Formatted string containing preferred UMich server.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICUseFTPProxy
Boolean value indicating whether to use an FTP proxy. Read-only in Mac OS X; use System Configuration to set this value.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICUseGopherProxy
Boolean value indicating whether to use a Gopher proxy. Read-only in Mac OS X; use System Configuration to set this value.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICUseHTTPProxy
Boolean value indicating whether to use an HTTP proxy. Read-only in Mac OS X; use System Configuration to set this value.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICUsePassiveFTP
Boolean value indicating whether to use the PASV command for FTP transfers.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICUseRTSPProxy
Boolean value indicating whether to use an RTSP proxy. Read-only in Mac OS X; use System Configuration to set this value.
Available in Mac OS X v10.1 and later.
Declared in InternetConfig.h
.
kICUseSocks
Boolean value indicating whether to use SOCKS.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICWAISGateway
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICWWWHomePage
User’s default Web home page.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICWebBackgroundColour
Background color for Web pages.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICWebReadColor
Color for Web links that have been visited.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICWebSearchPagePrefs
URL for the default search engine page.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICWebTextColor
Color for normal text on Web pages.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICWebUnderlineLinks
Boolean value indicating whether to underline Web links.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICWebUnreadColor
Color for Web links that have not been visited.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICWhoisHost
Default whois server.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
enum { ICmap_binary_bit = kICMapBinaryBit, ICmap_binary_mask = kICMapBinaryMask, ICmap_resource_fork_bit = kICMapResourceForkBit, ICmap_resource_fork_mask = kICMapResourceForkMask, ICmap_data_fork_bit = kICMapDataForkBit, ICmap_data_fork_mask = kICMapDataForkMask, ICmap_post_bit = kICMapPostBit, ICmap_post_mask = kICMapPostMask, ICmap_not_incoming_bit = kICMapNotIncomingBit, ICmap_not_incoming_mask = kICMapNotIncomingMask, ICmap_not_outgoing_bit = kICMapNotOutgoingBit, ICmap_not_outgoing_mask = kICMapNotOutgoingMask, ICmap_fixed_length = kICMapFixedLength };
For descriptions of these constants, see “Map Entry Flags” and “Map Entry Masks.” These constants are available only if you define OLDROUTINENAMES
.
typedef long ICMapEntryFlags; enum { kICMapBinaryBit = 0, kICMapResourceForkBit = 1, kICMapDataForkBit = 2, kICMapPostBit = 3, kICMapNotIncomingBit = 4, kICMapNotOutgoingBit = 5 };
kICMapBinaryBit
When this bit is set, indicates the file should be transferred in binary as opposed to text mode.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMapResourceForkBit
When this bit is set, indicates the resource fork of the file is significant.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMapDataForkBit
When this bit is set, indicates the data fork of the file is significant.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMapPostBit
When this bit is set, indicates post process using post fields.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMapNotIncomingBit
When this bit is set, indicates to ignore this mapping for incoming files.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMapNotOutgoingBit
When this bit is set, indicates to ignore this mapping for outgoing files.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
enum { kICMapBinaryMask = 0x00000001, kICMapResourceForkMask = 0x00000002, kICMapDataForkMask = 0x00000004, kICMapPostMask = 0x00000008, kICMapNotIncomingMask = 0x00000010, kICMapNotOutgoingMask = 0x00000020 };
kICMapBinaryMask
Indicates the file should be transferred in binary as opposed to text mode.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMapResourceForkMask
Indicates the resource fork of the file is significant.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMapDataForkMask
Indicates the data fork of the file is significant.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMapPostMask
Indicates to post process using post fields.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMapNotIncomingMask
Indicates to ignore this mapping for incoming files.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICMapNotOutgoingMask
Indicates to ignore this mapping for outgoing files.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
typedef short ICFixedLength; enum { kICMapFixedLength = 22 };
kICMapFixedLength
Use in the fixedLength
field of a structure ICMapEntry
.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
enum { ICservices_tcp_bit = kICServicesTCPBit, ICservices_tcp_mask = kICServicesTCPMask, ICservices_udp_bit = kICServicesUDPBit, ICservices_udp_mask = kICServicesUDPMask };
These constants are available only if you define OLDROUTINENAMES
.
The ICPerm type is used to specify whether you wish to access the preferences as read-only or read/write.
typedef UInt8 ICPerm; enum { icNoPerm = 0, icReadOnlyPerm = 1, icReadWritePerm = 2 };
typedef UInt32 ICAttr; enum { kICAttrLockedBit = 0, kICAttrVolatileBit = 1 }; enum { kICAttrNoChange = 0xFFFFFFFF, kICAttrLockedMask = 0x00000001, kICAttrVolatileMask = 0x00000002 };
kICAttrLockedBit
If the locked bit is set, any attempt to set the preference will result in an error.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICAttrVolatileBit
If the volatile bit is set, you should not cache the value of this preference because it is subject to non-seed changing changes.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICAttrNoChange
Used when you call ICSetPref and do not want to mess around with attributes. You can supply this value and IC will not change the attribute of the preference.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICAttrLockedMask
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICAttrVolatileMask
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
The ICAttr type is simply a longint containing flags that describe the attributes of a key and its data.
enum { kICAttrNoChange = 0xFFFFFFFF, kICAttrLockedMask = 0x00000001, kICAttrVolatileMask = 0x00000002 };
The ICProfileID
type is an opaque reference to a particular profile.
typedef long ICProfileID; typedef ICProfileID * ICProfileIDPtr; enum { kICNilProfileID = 0 };
kICNilProfileID
Use to denote no profile.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
typedef short ICServiceEntryFlags; enum { kICServicesTCPBit = 0, kICServicesUDPBit = 1 };
kICServicesTCPBit
When this bit is set, indicates the service is TCP.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICServicesUDPBit
When this bit is set, indicates the service is UDP.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
Both these bits may be set to indicate the service is both TCP and UDP.
enum { kICServicesTCPMask = 0x00000001, kICServicesUDPMask = 0x00000002 };
kICServicesTCPMask
Indicates the service is TCP.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
kICServicesUDPMask
Indicates the service is UDP.
Available in Mac OS X v10.0 and later.
Declared in InternetConfig.h
.
Both these bits may be set to indicate the service is both TCP and UDP.
enum { kICNoUserInteractionBit = 0 };
enum { kICNoUserInteractionMask = 0x00000001 };
enum { kICComponentVersion = 0, kICNumVersion = 1 };
The most common result codes returned by Internet Config are listed in the table below.
© 2003 Apple Computer, Inc. All Rights Reserved. (Last updated: 2003-05-01)