share/man/man3sip/sip_hold_dialog.3sip

   1 '\" te
   2 .\"  Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH SIP_HOLD_DIALOG 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_hold_dialog, sip_release_dialog \- hold/release reference on a dialog
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsip\fR [ \fIlibrary\fR ... ]
  13 #include <sip.h>
  14
  15 \fBvoid\fR \fIsip_hold_dialog\fR(\fBsip_dialog_t\fR \fIdialog\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBvoid\fR \fIsip_release_dialog\fR(\fBsip_dialog_t\fR \fIdialog\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 For functions that return a pointer of type \fBsip_str_t\fR, \fBsip_str_t\fR is
  27 supplied by:
  28 .sp
  29 .in +2
  30 .nf
  31 typedef struct sip_str {
  32      char       *sip_str_ptr;
  33      int        sip_str_len;
  34 }sip_str_t;
  35 .fi
  36 .in -2
  37
  38 .sp
  39 .LP
  40 The \fIsip_str_ptr\fR parameter points to the start of the returned value and
  41 \fIsip_str_len\fR supplies the length of the returned value.
  42 .sp
  43 .LP
  44 The \fBsip_hold_dialog()\fR function is used to hold a reference on the
  45 \fIdialog\fR. A dialog is not freed if there are any references on it.
  46 .sp
  47 .LP
  48 The \fBsip_release_dialog()\fR function is used to release a reference in the
  49 \fIdialog\fR. If the reference in a dialog drops to \fB0\fR and it is in
  50 \fBSIP_DLG_DESTROYED\fR state, it is freed.
  51 .SH RETURN VALUES
  52 .sp
  53 .LP
  54 The value of \fBerrno\fR is not changed by these calls in the event of an
  55 error.
  56 .SH ATTRIBUTES
  57 .sp
  58 .LP
  59 See \fBattributes\fR(5) for descriptions of the following attributes:
  60 .sp
  61
  62 .sp
  63 .TS
  64 box;
  65 c | c
  66 l | l .
  67 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  68 _
  69 Interface Stability     Committed
  70 _
  71 MT-Level        MT-Safe
  72 .TE
  73
  74 .SH SEE ALSO
  75 .sp
  76 .LP
  77 \fBlibsip\fR(3LIB)