Manuals / Apple / Computer Equipment / Network Card

Apple Network Setup manual OTCfgGetEntitiesList

Models: Network Setup

1 184

Download 184 pages 5.56 Kb

Page 74

C H A P T E R 3

Network Setup Reference

itemCount On input, a pointer to a value of type ItemCount. On output, itemCount contains the number of entities that matched the speciﬁed class and type.

function result A value of noErr indicates that OTCfgGetEntitiesCount returned successfully. For a list of other possible result codes, see “Result Codes” (page 110).

DISCUSSION

The OTCfgGetEntitiesCount function obtains the number of entities of the speciﬁed class and type in the speciﬁed area. With the number of entities, you can call OTCfgGetEntitiesList (page 74) to get the list of entities in the area.

OTCfgGetEntitiesList

Obtains information about entities in an area.

OSStatus OTCfgGetEntitiesList (CfgDatabaseRef dbRef,

CfgAreaID areaID,

CfgEntityClass entityClass,

CfgEntityType entityType,

ItemCount* itemCount,

CfgEntityRef entityRef[],

CfgEntityInfo entityInfo[]);

dbRef	On input, a value of type CfgDatabaseRef (page 98) that
	represents a database session previously opened by calling
	OTCfgOpenDatabase (page 58).
areaID	On input, a value of type CfgAreaID (page 98) that identiﬁes the
	area that is to be searched. If the area speciﬁed by areaID does
	not exist, OTCfgGetEntitiesCount returns the error
	kCfgErrAreaNotFound.
entityClass	On input, a value of type CfgEntityClass that speciﬁes the class
	that is to be matched. To specify all classes, set entityClass to
	kCfgClassAnyEntity. For a list of possible classes, see “Entity
	Classes and Types” (page 104).

74Network Setup Functions

Image 74

Apple Network Setup manual OTCfgGetEntitiesList

Contents

I N S I D E M A C I N T O S H Network Setup Apple Computer, Inc 2000 Apple Computer, Inc. All rights reserved Using Network Setup ContentsAbout Network Setup About This ManualNetwork Setup Reference ChapterChapter 4 Network Setup Protocol Structures and Data Types Glossary IndexPage Figures, Tables, and Listings About Network SetupUsing Network Setup ChapterPage About This Manual Conventions Used in This ManualInside Macintosh Networking with Open Transport For More InformationInside AppleTalk, Second Edition Open Transport Advanced Client Programming, available atAbout Network Setup Network Setup ArchitectureThe architecture shown in Figure 1-1 had a number of drawbacks The following key points are to be taken from Figure Inside the Network Setup Library High-level framework About Network Setup Figure 1-4 Structure of the Network Setup LibraryInside the Network Setup Library Mid-level database OTCfgNetwork Setup Database Fundamentals Database StructureDatabase Structure Example 18 Network Setup Database Fundamentals About Network SetupFigure 1-5 Sample organization of the default area LocalTalk for Printer AppleTalk networkork protocol entityDatabase Operations Figure 1-6 shows this process diagrammatically Legacy Issues Preference CoherencyLegacy Synchronization Algorithm Mac OS version Network Setup Version HistoryVersion C H A P T E R About Network Setup24 Network Setup Version History Opening the Database for Reading Using Network SetupOpening and Closing the Network Setup Database 26 Opening and Closing the Network Setup Database Opening the Database for WritingUsing Network Setup Listing 2-1 Opening the database for reading Listing 2-2 Opening the database for writing Using Network SetupOpening and Closing the Network Setup Database Closing the Database After Reading Closing the Database After WritingListing 2-4 Closing the database after writing Using Network SetupOpening and Closing the Network Setup Database err = OTCfgCommitAreaModificationsdbRef, readArea, writeAreaWorking with Entities Listing All EntitiesOSType entityClass OSType entityType CfgEntityRef **entityRefs kCfgClassAnyEntity and kCfgTypeAnyEntity, respectivelystatic OSStatus MyGetEntitiesListCfgDatabaseRef dbRef, CfgAreaID area CfgEntityInfo **entityInfosUsing Network Setup 32 Working with EntitiesThe next routine, shown in Listing 2-6, opens the database for reading, gets the entity references for all of the TCP/IP network connection entities in the default area using the MyGetEntitiesList routine in Listing 2-5, and prints their user-visible names. This routine calls a routine, MyGetEntityUserVisibleName, which hasn’t been documented yet. It is shown in Listing 2-9 in the section “Reading and Writing Preferences” page Reading and Writing Preferences Finding an Active EntityListing 2-7 Reading a ﬁxed-size preference Reading Fixed-size PreferencesUsing Network Setup Reading and Writing PreferencesThe sample shown in Listing 2-7, which opens and closes the entity before reading each preference, is implemented in an inefﬁcient manner for the sake of clarity. If you are reading multiple preferences, it is more efﬁcient to open the entity once. Then read the preferences by calling OTCfgGetPrefs or OTCfgSetPrefs multiple times and close the entity when you’re done Reading Variable-size Preferences assertdbRef != nil assertentity != nil assertname != nilUsing Network Setup 38 Reading and Writing PreferencesWriting Preferences Iterating the Preferences in an Entity Using Network Setup Reading and Writing PreferencesWorking with Sets Finding the Active Set Entity The MyFindActiveSet routine in Listing 2-13 implements the ﬁrst two steps. It starts by getting a list of all of the set entities by calling the MyGetEntitiesList routine Listing 2-5. Then MyFindActiveSet iterates through all of the set entities, reading the kOTCfgSetsStructPref preference of each set entity. That preference maps to the CfgSetsStruct structure, which contains an fFlags member. One bit of the fFlags member, kOTCfgSetsFlagActiveMask, indicates whether this set entity is the active set entity. If it is, the routine breaks out of the loop and returns the set’s entity reference to the caller breaks out of the loop and returns the found entity 46 Working with Sets Using Network SetupListing 2-14 Finding the active entity of a given class and type Working with Sets Using Network SetupListing 2-15 Finding the active TCP/IP entity Areas and Sets Protocol-speciﬁc Topics TCP/IP Notesaccess the preference in its packed format cursor = UInt8 * packedPref Using Network SetupProtocol-speciﬁc Topics UInt8 *cursor Using Network Setup52 Protocol-speciﬁc Topics Remote Access Notes Modem Notes OTCfgRemoteClientLocks pageStoring Third-party Preferences in Apple Entities Network Setup and Third-party Protocol StacksNotes for Third Parties C H A P T E R Using Network Setup56 Notes for Third Parties Opening and Closing the Network Setup Database Network Setup ReferenceNetwork Setup Functions OTCfgOpenDatabase OTCfgCloseDatabaseManaging Areas OTCfgGetCurrentArea OTCfgSetCurrentArea OTCfgOpenAreaOTCfgCloseArea OTCfgBeginAreaModiﬁcations function resultOTCfgCommitAreaModiﬁcations function resultfunction result OTCfgAbortAreaModiﬁcationsOTCfgIsSameAreaID OTCfgAbortAreaModifications returns kCfgErrAreaNotFoundOTCfgGetAreaName function resultOTCfgSetAreaName function resultfunction result OTCfgGetAreasCountOTCfgGetAreasList that are available. On output, itemCount points to the number of function resultOTCfgCreateArea function resultOTCfgDuplicateArea function resultManaging Entities OTCfgDeleteAreaOTCfgGetEntitiesCount OTCfgGetEntitiesList entityType On input, a value of type CfgEntityType that speciﬁes the type that is to be matched. To specify all types, set entityType to kCfgTypeAnyEntity. For a list of possible types, see “Entity Classes and Types” page OTCfgIsSameEntityRef OTCfgCreateEntityOn input, a value of type CfgDatabaseRef page 98 that function resultfunction result OTCfgDeleteEntityOTCfgDuplicateEntity const CfgEntityRef* entityRef, const CfgEntityRef* newEntityRefOTCfgGetEntityLogicalName OTCfgGetEntityName function result NoneOTCfgSetEntityName function resultfunction result OTCfgGetEntityAreaOTCfgChangeEntityArea Managing Preferences function result NoneOTCfgOpenPrefs function resultOTCfgClosePrefs OTCfgGetPrefsSizevoid* data, ByteCount length OTCfgGetPrefsfunction result const void* data, ByteCount length OTCfgSetPrefsfunction result OTCfgGetPrefsTOCCount OTCfgGetPrefsTOC OTCfgGetDefault OTCfgDeletePrefsOTCfgGetTemplate Preference Utilities function resultOTCfgEncrypt OTCfgDecryptInstalling and Removing a Notiﬁcation Callback OTCfgInstallNotiﬁerOn input, a value of type CfgDatabaseRef page 98 that function resultfunction result Application-Deﬁned RoutinesOTCfgRemoveNotiﬁer Network Setup Structures and Data Types Notiﬁcation Callback RoutineCfgDatabaseRef CfgAreaIDField descriptions CfgEntityRefCfgEntityInfo CfgEntityAccessID CfgPrefsHeaderCfgResourceLocator CfgSetsStructFlags for this set. For possible values, see the enumeration CfgSetsElement CfgSetsVectorNetwork Setup Constants Entity Classes and TypesWildcard Classes and Types Common Preference Types Per-connection Preference TypesGlobal Preference Types Global Backward Compatibility Preference Types Set Entity Preference TypesBackward Compatibility Preference Types Invalid Area ID OTCfgUserMode PreferenceResult Codes TCP/IP Structures Network Setup Protocol Structures and Data TypesProtocol Structures OTCfgTCPInterfacesUnpacked modulekMaxModuleNameSize partsizeofOTCfgTCPInterfacesPackedPart OTCfgTCPInterfacesPackedOTCfgTCPInterfacesPackedPart OTCfgTCPDHCPLeaseInfo OTCfgTCPDNSServersList OTCfgTCPLockslockDNSServersList lockAdminDomainNamelockLocalDomainName Set to TRUE to lock the “Router address” text ﬁeld OTCfgTCPRoutersListEntry page 119 structures OTCfgTCPRoutersListOTCfgTCPRoutersListEntry OTCfgTCPSearchDomains OTCfgTCPSearchListOTCfgTCPUnloadAttr Apple Remote Access Structures OTCfgRemoteAlternateAddress OTCfgRemoteApplicationOTCfgRemoteARAP regUserOrGuestLock OTCfgRemoteClientLocksuseVerboseLogLock The “Allow error correction and compression in modem” connectAutomatically OTCfgRemoteClientMiscOTCfgRemoteConnect canInteractOTCfgRemotePPPConnectScript issueConnectedRemindersallowModemDataCompression If Notification Manager reminders are enabled, the number OTCfgRemoteDialAssist isAssisted to 1 to use Dial Assist. When isAssisted is set tomade. Only valid if dialMode is not kOTCfgRemoteRedialNone OTCfgRemoteDialingadditionalPtr OTCfgRemoteIPCP OTCfgRemoteLCP lowerLayerName36kOTCfgRemoteAcceptedVersion. When reading the version OTCfgRemotePassword OTCfgRemoteLogOptionsconfigIDs1 OTCfgRemoteServerconfigCount OTCfgRemoteNetworkProtocol OTCfgRemoteServerPortstruct OTCfgRemoteServerPort serialLayerNamekMaxProviderNameSizeNetwork Setup Protocol Structures and Data Types OTCfgRemoteTerminalAccess mode flags. For possible values, see the Must be TRUEOTCfgRemoteUserMode OTCfgRemoteX25 Modem Structures OTCfgModemGeneralOTCfgModemApplication OTCfgModemLocks AppleTalk Structures OTCfgATalkGeneral OTCfgATalkGeneralAARP OTCfgATalkGeneralADSP fMaxConsecutiveDataPacketsPage OTCfgATalkGeneralASP fDefaultReleaseTimer OTCfgATalkGeneralATPfDefaultRetryInterval Protocol Structures OTCfgATalkGeneralDDPNetwork Setup Protocol Structures and Data Types fMyZonekZIPMaxZoneLength+1The maximum amount of data that packets of this protocol OTCfgATalkGeneralNBP fDefaultTickleRetries OTCfgATalkGeneralPAPfDefaultTickleInterval fDefaultPAPEOMEnabledOTCfgATalkGeneralZIP OTCfgATalkLocks OTCfgATalkNetworkArchitecture Constant descriptions kOTCfgATalkPortLockMaskInfrared Structures OTCfgATalkPortDeviceTypeProtocol Constants and Other Data Types OTCfgIRGeneral“AppleTalk Constants and Other Data Types” page TCP/IP Constants and Other Data TypesNetwork Setup Protocol Structures and Data Types “Infrared Constants and Other Data Types” page0x0002 Masks for the kOTCfgProtocolOptionsPref PreferencekDontShutDownOnARPCollisionMask = 0x0004OTCfgTCPConﬁgMethod Apple Remote Access Constants and Other Data Types ARA Per-Connection Preferences TypesThe preference type for the OTCfgRemoteDialing page 131 structure Network Setup Protocol Structures and Data TypesThe preference type for the OTCfgRemoteARAP page 124 structure The preference type for the OTCfgRemoteClientLocks page 125 structureThe preference type for the OTCfgRemoteConnect page 127 structure ARA Global Preference Types OTCfgRemotePPPConnectScriptOTCfgRemoteProtocol OTCfgRemoteLogLevel OTCfgRemoteDialModeOTCfgRemoteAnswerMode OTCfgRemoteNetworkProtocolOTCfgRemoteNetAccessMode Modem Constants and Other Data TypesModem Global Preference Types OTCfgModemDialingToneModeAppleTalk Constants and Other Data Types Per-connection AppleTalk Preference TypesInfrared Constants and Other Data Types Global AppleTalk Preference TypesOTCfgIRPortSetting Glossary maximum transmission unit MTU The maximum number of bytes in a packet media access control address The six-byte Transmission Control Protocol/Internet Protocol A connection-oriented transport-layer Internet protocol that provides reliable full-duplex data transmission Index Page legacy preference ﬁles named areas network connection entities 16 Network Setupnotiﬁcation routine installing 94 removing mid-level database 15 modem constants 170 multihoming 12Page TCP/IP constants 160 preferences set entities 16 active, number of 43 usingsetting entity names 81 structures temporary area 20 third-party developers 55 type, entityI N D E