Legacy Documentclose button

Important: The information in this document is obsolete and should not be used for new development.

Previous Book Contents Book Index Next

Inside Macintosh: Files /
Chapter 2 - File Manager / File Manager Reference
Shared Environment Routines / Controlling Login Access


PBHGetLogInInfo

You can use the PBHGetLogInInfo function to determine the login method used to log on to a particular shared volume.

FUNCTION PBHGetLogInInfo (paramBlock: HParmBlkPtr; 
                           async: Boolean): OSErr;
paramBlock
A pointer to an objParam variant of the HFS parameter block.
async
A Boolean value that specifies asynchronous (TRUE) or synchronous (FALSE) execution.
-->ioCompletionProcPtrA pointer to a completion routine.
<--ioResultOSErrThe result code of the function.
-->ioVRefNumIntegerThe volume specification.
<--ioObjTypeIntegerThe login method.
<--ioObjNamePtrPtrA pointer to the user name.

DESCRIPTION
The PBHGetLogInInfo function returns the method used for login and the user name specified at login time for the volume specified by the ioVRefNum field. The login user name is returned as a Pascal string in ioObjNamePtr. The maximum size of the user name is 31 characters. The login method type is returned in the ioObjType field. These values are recognized.

CONST
   kNoUserAuthentication   = 1;  {no password}
   kPassword               = 2;  {8-byte password}
   kEncryptPassword        = 3;  {encrypted 8-byte password}
   kTwoWayEncryptPassword  = 6;  {two-way random encryption}
Values in the range 7-127 are reserved for future use by Apple Computer, Inc. Values in the range 128-255 are available to your application as user-defined values.

ASSEMBLY-LANGUAGE INFORMATION
The trap macro and routine selector for PBHGetLogInInfo are
Trap macroSelector
_HFSDispatch$0031

RESULT CODES
noErr0No error
nsvErr-35Specified volume doesn't exist
paramErr-50Function not supported by volume

Previous Book Contents Book Index Next

© Apple Computer, Inc.
2 JUL 1996