share/man/man3sip/sip_delete_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_DELETE_DIALOG 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_delete_dialog \- delete 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_delete_dialog\fR(\fBsip_dialog_t\fR \fIdialog\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 For functions that return a pointer of type \fBsip_str_t\fR, \fBsip_str_t\fR is
  22 supplied by:
  23 .sp
  24 .in +2
  25 .nf
  26 typedef struct sip_str {
  27      char       *sip_str_ptr;
  28      int        sip_str_len;
  29 }sip_str_t;
  30 .fi
  31 .in -2
  32
  33 .sp
  34 .LP
  35 The \fIsip_str_ptr\fR parameter points to a specified value at the start of an
  36 input string. The \fIsip_str_len\fR supplies the length of the returned value
  37 starting from \fIsip_str_ptr\fR.
  38 .sp
  39 .LP
  40 The \fBsip_delete_dialog()\fR function is used to delete the dialog specified
  41 in \fIdialog\fR. The dialog is not freed if it has outstanding references on
  42 it. When the last reference is released the dialog is freed.
  43 .SH RETURN VALUES
  44 .sp
  45 .LP
  46 The value of \fBerrno\fR is not changed by these calls in the event of an
  47 error.
  48 .SH ATTRIBUTES
  49 .sp
  50 .LP
  51 See \fBattributes\fR(5) for descriptions of the following attributes:
  52 .sp
  53
  54 .sp
  55 .TS
  56 box;
  57 c | c
  58 l | l .
  59 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  60 _
  61 Interface Stability     Committed
  62 _
  63 MT-Level        MT-Safe
  64 .TE
  65
  66 .SH SEE ALSO
  67 .sp
  68 .LP
  69 \fBlibsip\fR(3LIB)