usr/src/man/man3sasl/sasl_auxprop_getctx.3sasl

   1 '\" te
   2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems,
   4 .\" Inc. All Rights Reserved
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH SASL_AUXPROP_GETCTX 3SASL "Aug 22, 2003"
   9 .SH NAME
  10 sasl_auxprop_getctx \- acquire an auxiliary property context
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/sasl.h>
  16
  17 \fBstruct propctx *\fR\fBsasl_auxprop_getctx\fR(\fBsasl_conn_t *\fR\fIconn\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBsasl_auxprop_getctx()\fR interface returns an auxiliary property context
  24 for the given \fBsasl_conn_t\fR on which the sasl auxiliary property functions
  25 can operate. See \fBsasl_auxprop\fR(3SASL).
  26 .SH PARAMETERS
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIconn\fR\fR
  31 .ad
  32 .RS 8n
  33 The \fBsasl_conn_t\fR for which the request is being made
  34 .RE
  35
  36 .SH RETURN VALUES
  37 .sp
  38 .LP
  39 \fBsasl_auxprop_getctx()\fR returns a pointer to the context, upon success.
  40 \fBsasl_auxprop_getctx()\fR returns \fINULL\fR upon failure.
  41 .SH ATTRIBUTES
  42 .sp
  43 .LP
  44 See \fBattributes\fR(5) for descriptions of the following attributes:
  45 .sp
  46
  47 .sp
  48 .TS
  49 box;
  50 c | c
  51 l | l .
  52 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  53 _
  54 Interface Stability     Evolving
  55 _
  56 MT-Level        Safe
  57 .TE
  58
  59 .SH SEE ALSO
  60 .sp
  61 .LP
  62 \fBattributes\fR(5)