share/man/man3sasl/sasl_set_alloc.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_SET_ALLOC 3SASL "Oct 22, 2003"
   9 .SH NAME
  10 sasl_set_alloc \- set the memory allocation functions used by the SASL library
  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 \fBvoid\fR \fBsasl_set_alloc\fR(\fBsasl_malloc_t *\fR\fIm\fR, \fBsasl_calloc_t *\fR\fIc\fR, \fBsasl_realloc_t *\fR\fIr\fR,
  18      \fBsasl_free_t *\fR\fIf\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 Use the \fBsasl_set_alloc()\fR interface to set the memory allocation routines
  25 that the SASL library and plug-ins will use.
  26 .SH PARAMETERS
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIc\fR\fR
  31 .ad
  32 .RS 5n
  33 A pointer to a \fBcalloc()\fR function
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIf\fR\fR
  40 .ad
  41 .RS 5n
  42 A pointer to a \fBfree()\fR function
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIm\fR\fR
  49 .ad
  50 .RS 5n
  51 A pointer to a\fBmalloc()\fR function
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fIr\fR\fR
  58 .ad
  59 .RS 5n
  60 A pointer to a \fBrealloc()\fR function
  61 .RE
  62
  63 .SH RETURN VALUES
  64 .sp
  65 .LP
  66 \fBsasl_set_alloc()\fR has no return values.
  67 .SH ATTRIBUTES
  68 .sp
  69 .LP
  70 See \fBattributes\fR(5) for descriptions of the following attributes:
  71 .sp
  72
  73 .sp
  74 .TS
  75 box;
  76 c | c
  77 l | l .
  78 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  79 _
  80 Interface Stability     Obsolete
  81 _
  82 MT-Level        Unsafe
  83 .TE
  84
  85 .SH SEE ALSO
  86 .sp
  87 .LP
  88 \fBattributes\fR(5)
  89 .SH NOTES
  90 .sp
  91 .LP
  92 While most of \fBlibsasl\fR is MT-Safe, \fBsasl_set_*\fR modifies the global
  93 state and should be considered Unsafe.