Carbon


NSLOpenNavigationAPI

Header: NSL.h Carbon status: Supported

Opens a session with the NSL Manager.

OSStatus NSLOpenNavigationAPI (
    NSLClientRef *newRef
);
Parameter descriptions
newRef

On input, a pointer to an NSLClientRef in which the NSL Manager returns a value that your application uses in subsequent NSLPrepareRequest and NSLCloseNavigationAPI calls.

function result

A result code. A value of noErr indicates that the session was opened and all available plug-ins loaded successfully. A value of kNSLSomePluginsFailedToLoad indicates that the session was opened and at least one plug-in loaded successfully. If NSLOpenNavigationAPI returns any of the following error codes, your application should not call any other NSL Manager functions: kNSLNotInitialized, kNSLInsufficientSysVer, kNSLInsufficientOTVer, kNSLPluginLoadFailed, or kNSL68kContextNotSupported.

DISCUSSION

The NSLOpenNavigationAPI function opens a session with the NSL Manager and returns an NSLClientRef that your application later uses to prepare NSL lookup requests and to close the NSL session. If no other application has opened a session, calling NSLOpenNavigationAPI initializes the NSL Manager. You must call NSLOpenNavigationAPI before you call any other NSL Manager functions.


© 2000 Apple Computer, Inc. (Last Updated 7/13/2000)