xref: /illumos-gate/usr/src/man/man3proc/Lfree.3proc (revision a7d7cafe)
143051d27SRobert Mustacchi.\"
243051d27SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
343051d27SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
443051d27SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
543051d27SRobert Mustacchi.\" 1.0 of the CDDL.
643051d27SRobert Mustacchi.\"
743051d27SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
843051d27SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
943051d27SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
1043051d27SRobert Mustacchi.\"
1143051d27SRobert Mustacchi.\"
1243051d27SRobert Mustacchi.\" Copyright 2015 Joyent, Inc.
1343051d27SRobert Mustacchi.\"
14*a7d7cafeSRobert Mustacchi.Dd November 27, 2023
1543051d27SRobert Mustacchi.Dt LFREE 3PROC
1643051d27SRobert Mustacchi.Os
1743051d27SRobert Mustacchi.Sh NAME
1843051d27SRobert Mustacchi.Nm Lfree
1943051d27SRobert Mustacchi.Nd free a control handle to a thread
20*a7d7cafeSRobert Mustacchi.Sh LIBRARY
2143051d27SRobert Mustacchi.Lb libproc
22*a7d7cafeSRobert Mustacchi.Sh SYNOPSIS
2343051d27SRobert Mustacchi.In libproc.h
2443051d27SRobert Mustacchi.Ft "void"
2543051d27SRobert Mustacchi.Fo Lfree
2643051d27SRobert Mustacchi.Fa "struct ps_lwphandle *L"
2743051d27SRobert Mustacchi.Fc
2843051d27SRobert Mustacchi.Sh DESCRIPTION
2943051d27SRobert MustacchiThe
3043051d27SRobert Mustacchi.Fn Lfree
31bccbd30bSPeter Tribblefunction releases all control resources associated with the handle
3243051d27SRobert Mustacchi.Fa L .
3343051d27SRobert MustacchiAfter
34bccbd30bSPeter Tribble.Fn Lfree ,
35bccbd30bSPeter Tribblecalls to other
3643051d27SRobert Mustacchi.Sy libproc
3743051d27SRobert Mustacchiroutines which leverage information from the handle
3843051d27SRobert Mustacchi.Fa L
3943051d27SRobert Mustacchiwill no longer work as the handle has been invalidated.
4043051d27SRobert Mustacchi.Pp
4143051d27SRobert MustacchiThe state of the thread controlled by
4243051d27SRobert Mustacchi.Fa L
4343051d27SRobert Mustacchiis not affected by the call to
4443051d27SRobert Mustacchi.Fn Lfree .
4543051d27SRobert MustacchiThe thread's state will not transition from running to stopped or
4672d3dbb9SYuri Pankovvice-versa.
4772d3dbb9SYuri PankovIt will retain its state prior to the call to
4843051d27SRobert Mustacchi.Fn Lfree .
4943051d27SRobert Mustacchi.Sh INTERFACE STABILITY
5043051d27SRobert Mustacchi.Sy Uncommitted
5143051d27SRobert Mustacchi.Sh MT-LEVEL
5243051d27SRobert Mustacchi.Sy MT-Safe
5343051d27SRobert Mustacchi.Sh SEE ALSO
5443051d27SRobert Mustacchi.Xr libproc 3LIB ,
5543051d27SRobert Mustacchi.Xr Lgrab 3PROC
56