krb5_cc_start_seq_get()--Start Sequentially Retrieving Entries from a Credentials Cache


  Syntax 
 #include <krb5.h>

 krb5_error_code krb5_cc_start_seq_get(  
     krb5_context     context,  
     krb5_ccache      cache,  
     krb5_cc_cursor *     cursor);
  Service Program Name: QSYS/QKRBGSS

  Default Public Authority: *USE

  Threadsafe: Yes

The krb5_cc_start_seq_get() function starts sequentially retrieving entries from the credentials cache. The krb5_cc_next_cred() routine is called repeatedly to retrieve each successive cache entry. The krb5_cc_end_seq_get() routine is called at the completion of the read operations.


Authorities

Object Referred to Data Authority Required
Each directory in the path name preceding the credentials cache file *X
Credentials cache file *R


Parameters

context  (Input)
The Kerberos context.

cache  (Input)
The credentials cache handle.

cursor  (Output)
The cursor. The krb5_cc_end_seq_get() routine should be called to release the cursor at the completion of the sequential read operations.

Return Value

If no errors occur, the return value is 0. Otherwise, a Kerberos error code is returned.


Error Messages

Message ID Error Message Text
CPE3418 E Possible APAR condition or hardware failure.


Usage Notes

  1. The credentials cache is locked when the krb5_cc_start_seq_get() routine is called and remains locked until the krb5_cc_end_seq_get() routine is called. Write access to the cache by other processes and threads is blocked until the cache is unlocked. After the krb5_cc_start_seq_get() routine has been called, the current thread may not call any other credentials cache functions except krb5_cc_next_cred() and krb5_cc_end_seq_get() for the specified cache.

API introduced: V5R1

[ Back to top | Security APIs | UNIX-Type APIs | APIs by category ]