'\" te

.\" Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.

.TH gss_context_time 3GSS "22 Aug 2011" "SunOS 5.12" "Generic Security Services API Library Functions"

.SH NAME

gss_context_time \- determine how long a context will remain valid

.SH SYNOPSIS

.LP

.nf

\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR  [ \fIlibrary\fR... ] 

#include <gssapi/gssapi.h>

\fBOM_uint32\fR \fBgss_context_time\fR(\fBOM_uint32 *\fR\fIminor_status\fR,

     \fBgss_ctx_id_t *\fR\fIcontext_handle\fR,\fBOM_uint32 *\fR\fItime_rec\fR);

.fi

.SH DESCRIPTION

.sp

.LP

The \fBgss_context_time()\fR function determines the number of seconds for which the specified context will remain valid.

.SH PARAMETERS

.sp

.LP

The parameter descriptions for \fBgss_context_time()\fR are as follows:

.sp

.ne 2

.mk

.na

\fB\fIminor_status\fR\fR

.ad

.RS 18n

.rt  

A mechanism-specific status code.

.RE

.sp

.ne 2

.mk

.na

\fB\fIcontext_handle\fR\fR

.ad

.RS 18n

.rt  

A read-only value. Identifies the context to be interrogated.

.RE

.sp

.ne 2

.mk

.na

\fB\fItime_rec\fR\fR

.ad

.RS 18n

.rt  

Modifies the number of seconds that the context remains valid.  If the context has already expired, returns zero.

.RE

.SH ERRORS

.sp

.LP

The \fBgss_context_time()\fR function returns one of the following status codes:

.sp

.ne 2

.mk

.na

\fB\fBGSS_S_COMPLETE\fR\fR

.ad

.RS 25n

.rt  

Successful completion.

.RE

.sp

.ne 2

.mk

.na

\fB\fBGSS_S_CONTEXT_EXPIRED\fR\fR

.ad

.RS 25n

.rt  

The context has already expired.

.RE

.sp

.ne 2

.mk

.na

\fB\fBGSS_S_NO_CONTEXT\fR\fR

.ad

.RS 25n

.rt  

The \fIcontext_handle\fR parameter did not identify a valid context.

.RE

.sp

.ne 2

.mk

.na

\fB\fBGSS_S_FAILURE\fR\fR

.ad

.RS 25n

.rt  

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.

.RE

.SH ATTRIBUTES

.sp

.LP

See \fBattributes\fR(5) for descriptions of the following attributes:

.sp

.sp

.TS

tab() box;

cw(2.75i) |cw(2.75i) 

lw(2.75i) |lw(2.75i) 

.

ATTRIBUTE TYPEATTRIBUTE VALUE

_

MT LevelSafe

.TE

.SH SEE ALSO

.sp

.LP

\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)

.sp

.LP