xref: /illumos-gate/usr/src/man/man3proc/Lfree.3proc (revision 1a2d662a91cee3bf82f41cd47c7ae6f3825d9db2)
1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\"
12.\" Copyright 2015 Joyent, Inc.
13.\"
14.Dd November 27, 2023
15.Dt LFREE 3PROC
16.Os
17.Sh NAME
18.Nm Lfree
19.Nd free a control handle to a thread
20.Sh LIBRARY
21.Lb libproc
22.Sh SYNOPSIS
23.In libproc.h
24.Ft "void"
25.Fo Lfree
26.Fa "struct ps_lwphandle *L"
27.Fc
28.Sh DESCRIPTION
29The
30.Fn Lfree
31function releases all control resources associated with the handle
32.Fa L .
33After
34.Fn Lfree ,
35calls to other
36.Sy libproc
37routines which leverage information from the handle
38.Fa L
39will no longer work as the handle has been invalidated.
40.Pp
41The state of the thread controlled by
42.Fa L
43is not affected by the call to
44.Fn Lfree .
45The thread's state will not transition from running to stopped or
46vice-versa.
47It will retain its state prior to the call to
48.Fn Lfree .
49.Sh INTERFACE STABILITY
50.Sy Uncommitted
51.Sh MT-LEVEL
52.Sy MT-Safe
53.Sh SEE ALSO
54.Xr libproc 3LIB ,
55.Xr Lgrab 3PROC
56