Carbon


KCGetKeychain

Header: Keychain.h Carbon status: Under Evaluation

Determines the location of a password or other keychain item.

OSStatus KCGetKeychain (
    KCItemRef item, 
    KCRef *keychain
);
Parameter descriptions
item

A reference to the keychain item whose keychain location you wish to determine. If you pass a reference to a keychain item whose keychain is locked, KCGetKeychain returns the result code errKCInvalidItemRef.

keychain

On return, a pointer to the keychain containing the specified item.

function result

A result code. The result code errKCInvalidItemRef indicates that the keychain item reference was invalid.

DISCUSSION

The KCGetKeychain function determines the location of a keychain item that in an unlocked keychain. It will not search locked keychains. KCGetKeychain may display the Unlock Keychain dialog box if the keychain containing the item is currently locked.

SPECIAL CONSIDERATIONS

The keychain reference returned by KCGetKeychain should be released by calling the function KCReleaseItem.

VERSION NOTES

Available beginning with Keychain Manager 2.0.


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