.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2009
.\"   National Institute of Advanced Industrial Science and Technology (AIST)
.\" This file is part of the m17n library documentation.
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.2 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Section, no Front-Cover Texts,
.\" and no Back-Cover Texts.  A copy of the license is included in the
.\" appendix entitled "GNU Free Documentation License".
.TH "m17n_object_unref" 3m17n "15 Oct 2009" "" "Version 1.5.5" "" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
m17n_object_unref \- Decrement the reference count of a managed object. 


.SH SYNOPSIS
int
\fBm17n_object_unref\fP (void *
\fIobject\fP)


.SH DESCRIPTION
Decrement the reference count of a managed object. 
.PP
The
.ft B
m17n_object_unref()
.ft R
function decrements the reference count of the managed object pointed to by
.ft B
object\fP.
.ft R
When the reference count becomes zero, the object is freed by its freer function.
.PP
.SH RETURN VALUE
.PP
.RS 4
This function returns the resulting reference count if it fits in a 16\-bit unsigned integer (i.e. less than 0x10000). Otherwise, it returns \-1. Thus, the return value zero means that
.ft B
object
.ft R
is freed.
.RE
.PP
.SH ERRORS
.PP
.RS 4
This function never fails. 
.RE
.PP

.SH COPYRIGHT
Copyright (C) 2001 Information\-technology Promotion Agency (IPA)
.br
Copyright (C) 2001\-2009 National Institute of Advanced Industrial Science and Technology (AIST)
.br
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License 
<http://www.gnu.org/licenses/fdl.html>.
