Carbon


KCGetIndKeychain

Header: Keychain.h Carbon status: Under Evaluation

Obtains the reference to an indexed keychain.

OSStatus KCGetIndKeychain (
    UInt16 index, 
    KCRef *keychain
);
Parameter descriptions
index

An index of the list of available keychains. Pass a value between 1 and the number returned by the function KCCountKeychains.

keychain

A pointer to the keychain reference corresponding to the index in the index parameter.

function result

A result code. The result code errKCNoSuchKeychain indicates that the index value is out of range.

DISCUSSION

To guarantee correct operation, you should call the function KCCountKeychains once before calling KCGetIndKeychain.

SPECIAL CONSIDERATIONS

The memory that the keychain reference occupies must be released by calling the function KCReleaseKeychain when you are finished with it.

VERSION NOTES

Available beginning with Keychain Manager 1.0.


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