Macintosh Development

[Home] [About Us] [People] [Information Systems]
[Kerberos for Macintosh] [Applications] [Miscellaneous Documentation]

KerberosManagerLib API

OSStatus KMAE_SendOpenApplication(Boolean waitForAEReply)

Sends an open AppleEvent to Kerberos control panel. This will open the Kerberos control panel. If there is a Kerberos control panel in the Control Panels folder, that one will be launched, otherwise it will search the hard disk for one to launch (no guarantees as to which one).

If the Kerberos control panel is already open, it will be brought to the foreground by an activate event.

The Kerberos control panel may display an error on startup if there is a problem with MIT Kerberos for Macintosh, however, this fact will not be noted by the error code returned by this function.

The parameter waitForAEReply says whether kAEWaitReply (when true) or kAENoReply (when false) should be passed into the AESend() call. Even though no reply is passed back, certain applications may expect wait/no wait behavior.

Returns an error if no Kerberos control panel can be found.

OSStatus KMAE_SendOpenApplicationFSSpec (FSSpec *inKMFileSpec, Boolean waitForAEReply)

Send an open AppleEvent to the Kerberos control panel specified by inKMFileSpec. This will open the Kerberos control panel.

If the specified Kerberos control panel is already open, it will be brought to the foreground by an activate event.

The Kerberos control panel may display an error on startup if there is a problem with MIT Kerberos for Macintosh, however, this fact will not be noted by the error code returned by this function.

The parameter waitForAEReply says whether kAEWaitReply (when true) or kAENoReply (when false) should be passed into the AESend() call. Even though no reply is passed back, certain applications may expect wait/no wait behavior.

Returns an error if the specified the Kerberos control panel cannot be found.

OSStatus KMAE_SendLogin(Boolean waitForAEReply)

Sends a "login" AppleEvent to the Kerberos control panel, telling it to display the "new login" dialog. If the Kerberos control panel isn't running, it will be opened. If there is a Kerberos control panel in the Control Panels folder, that one will be launched, otherwise it will search the hard disk for one to launch (no guarantees as to which one).

The parameter waitForAEReply says whether kAEWaitReply (when true) or kAENoReply (when false) should be passed into the AESend() call. Even though no reply is passed back, certain applications may expect wait/no wait behavior.

No reply is sent back about the success or failure of the login.

Returns an error if no Kerberos control panel can be found.

OSStatus KMAE_SendLoginFSSpec(FSSpec *inKMFileSpec, Boolean waitForAEReply)

Sends a "login" AppleEvent to the Kerberos control panel specified by inKMFileSpec, telling KM to display the "new login" dialog. If the Kerberos control panel isn't running, it will be opened.

The parameter waitForAEReply says whether kAEWaitReply (when true) or kAENoReply (when false) should be passed into the AESend() call. Even though no reply is passed back, certain applications may expect wait/no wait behavior.

No reply is sent back about the success or failure of the login.

Returns an error the specified Kerberos control panel cannot be found.

OSStatus KMAE_SendQuitApplication(Boolean waitForAEReply)

Sends a quit AppleEvent to the Kerberos control panel.

Any currently open dialogs in the Kerberos control panel (such as a login dialog) will be dismissed without warning.

The parameter waitForAEReply says whether kAEWaitReply (when true) or kAENoReply (when false) should be passed into the AESend() call. Even though no reply is passed back, certain applications may expect wait/no wait behavior.

Returns an error if the Kerberos control panel isn't currently running.

Boolean KMAE_FindTargetKerberosManager(FSSpec *kmSpec)

Searches the startup volume to find the Kerberos control panel that would receive AppleEvents if any of the KerberosManagerLib functions that send AEs were called.

The search path is as follows: first checks to see if the Kerberos control panel is running, and returns the FSSpec of that one if it is. Next looks in the Control Panels Folder. Finally it searches the startup drive for a copy.

If the Kerberos control panel is found, returns true and fills out *kmSpec. If it doesn't find one or an error occurs, returns false and *kmSpec is unchanged.

If the hard drive catalog changes during the search, continues anyway.

Boolean IsKerberosManagerRunning (ProcessSerialNumber *outPSN)

Returns true if the Kerberos control panel is currently a running process, and fills out outPSN with that process's serial number (for use if the caller needs to determine other things about the Kerberos control panel process).

Returns false if it isn't running, and outPSN will be unchanged.

Boolean FindKerberosManagerInControlPanels(FSSpec *kmSpec)

Look for and return the FSSpec of the Kerberos control panel in the active System Folder's Control Panel folder.

Returns true and fills out kmSpec if the Kerberos control panel is found.

Returns false and kmSpec is unchanged if no Kerberos control panel can be found or an error occurs.

Questions or comments? Send mail to macdev@mit.edu
Last updated on $Date: 2003/11/19 20:42:11 $
Last modified by $Author: smcguire $