components/krb5/Solaris/man/gss_context_time.3gss
changeset 5490 9bf0bc57423a
child 7820 a2b9a7de9e1a
equal deleted inserted replaced
5489:a5031bb8b66d 5490:9bf0bc57423a
       
     1 '\" te
       
     2 .\" Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
       
     3 .TH gss_context_time 3GSS "22 Aug 2011" "SunOS 5.12" "Generic Security Services API Library Functions"
       
     4 .SH NAME
       
     5 gss_context_time \- determine how long a context will remain valid
       
     6 .SH SYNOPSIS
       
     7 .LP
       
     8 .nf
       
     9 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR  [ \fIlibrary\fR... ] 
       
    10 #include <gssapi/gssapi.h>
       
    11 
       
    12 \fBOM_uint32\fR \fBgss_context_time\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
       
    13      \fBgss_ctx_id_t *\fR\fIcontext_handle\fR,\fBOM_uint32 *\fR\fItime_rec\fR);
       
    14 .fi
       
    15 
       
    16 .SH DESCRIPTION
       
    17 .sp
       
    18 .LP
       
    19 The \fBgss_context_time()\fR function determines the number of seconds for which the specified context will remain valid.
       
    20 .SH PARAMETERS
       
    21 .sp
       
    22 .LP
       
    23 The parameter descriptions for \fBgss_context_time()\fR are as follows:
       
    24 .sp
       
    25 .ne 2
       
    26 .mk
       
    27 .na
       
    28 \fB\fIminor_status\fR\fR
       
    29 .ad
       
    30 .RS 18n
       
    31 .rt  
       
    32 A mechanism-specific status code.
       
    33 .RE
       
    34 
       
    35 .sp
       
    36 .ne 2
       
    37 .mk
       
    38 .na
       
    39 \fB\fIcontext_handle\fR\fR
       
    40 .ad
       
    41 .RS 18n
       
    42 .rt  
       
    43 A read-only value. Identifies the context to be interrogated.
       
    44 .RE
       
    45 
       
    46 .sp
       
    47 .ne 2
       
    48 .mk
       
    49 .na
       
    50 \fB\fItime_rec\fR\fR
       
    51 .ad
       
    52 .RS 18n
       
    53 .rt  
       
    54 Modifies the number of seconds that the context remains valid.  If the context has already expired, returns zero.
       
    55 .RE
       
    56 
       
    57 .SH ERRORS
       
    58 .sp
       
    59 .LP
       
    60 The \fBgss_context_time()\fR function returns one of the following status codes:
       
    61 .sp
       
    62 .ne 2
       
    63 .mk
       
    64 .na
       
    65 \fB\fBGSS_S_COMPLETE\fR\fR
       
    66 .ad
       
    67 .RS 25n
       
    68 .rt  
       
    69 Successful completion.
       
    70 .RE
       
    71 
       
    72 .sp
       
    73 .ne 2
       
    74 .mk
       
    75 .na
       
    76 \fB\fBGSS_S_CONTEXT_EXPIRED\fR\fR
       
    77 .ad
       
    78 .RS 25n
       
    79 .rt  
       
    80 The context has already expired.
       
    81 .RE
       
    82 
       
    83 .sp
       
    84 .ne 2
       
    85 .mk
       
    86 .na
       
    87 \fB\fBGSS_S_NO_CONTEXT\fR\fR
       
    88 .ad
       
    89 .RS 25n
       
    90 .rt  
       
    91 The \fIcontext_handle\fR parameter did not identify a valid context.
       
    92 .RE
       
    93 
       
    94 .sp
       
    95 .ne 2
       
    96 .mk
       
    97 .na
       
    98 \fB\fBGSS_S_FAILURE\fR\fR
       
    99 .ad
       
   100 .RS 25n
       
   101 .rt  
       
   102 The underlying mechanism detected an error for which no specific \fBGSS\fR status code is defined.  The mechanism-specific status code reported by means of the \fIminor_status\fR parameter details the error condition.
       
   103 .RE
       
   104 
       
   105 .SH ATTRIBUTES
       
   106 .sp
       
   107 .LP
       
   108 See \fBattributes\fR(5) for descriptions of the following attributes:
       
   109 .sp
       
   110 
       
   111 .sp
       
   112 .TS
       
   113 tab() box;
       
   114 cw(2.75i) |cw(2.75i) 
       
   115 lw(2.75i) |lw(2.75i) 
       
   116 .
       
   117 ATTRIBUTE TYPEATTRIBUTE VALUE
       
   118 _
       
   119 MT LevelSafe
       
   120 .TE
       
   121 
       
   122 .SH SEE ALSO
       
   123 .sp
       
   124 .LP
       
   125 \fBgss_init_sec_context\fR(3GSS), \fBgss_accept_sec_context\fR(3GSS), \fBgss_delete_sec_context\fR(3GSS), \fBgss_process_context_token\fR(3GSS), \fBgss_inquire_context\fR(3GSS), \fBgss_wrap_size_limit\fR(3GSS), \fBgss_export_sec_context\fR(3GSS), \fBgss_import_sec_context\fR(3GSS), \fBattributes\fR(5)
       
   126 .sp
       
   127 .LP
       
   128