xref: /titanic_50/usr/src/man/man3sip/sip_delete_dialog.3sip (revision 7932179448259e425d93162dedd251930575d83e)
te
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
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.
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.
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]
SIP_DELETE_DIALOG 3SIP "Jan 25, 2007"
NAME
sip_delete_dialog - delete a dialog
SYNOPSIS

cc [ flag ... ] file ... -lsip [ library ... ]
#include <sip.h>

void sip_delete_dialog(sip_dialog_t dialog);
DESCRIPTION

For functions that return a pointer of type sip_str_t, sip_str_t is supplied by:

typedef struct sip_str {
 char *sip_str_ptr;
 int sip_str_len;
}sip_str_t;

The sip_str_ptr parameter points to a specified value at the start of an input string. The sip_str_len supplies the length of the returned value starting from sip_str_ptr.

The sip_delete_dialog() function is used to delete the dialog specified in dialog. The dialog is not freed if it has outstanding references on it. When the last reference is released the dialog is freed.

RETURN VALUES

The value of errno is not changed by these calls in the event of an error.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level MT-Safe
SEE ALSO

libsip(3LIB)