share/man/man3proc/Lfree.3proc

   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 May 11, 2016
  15 .Dt LFREE 3PROC
  16 .Os
  17 .Sh NAME
  18 .Nm Lfree
  19 .Nd free a control handle to a thread
  20 .Sh SYNOPSIS
  21 .Lb libproc
  22 .In libproc.h
  23 .Ft "void"
  24 .Fo Lfree
  25 .Fa "struct ps_lwphandle *L"
  26 .Fc
  27 .Sh DESCRIPTION
  28 The
  29 .Fn Lfree
  30 function releases all control resources associated with the handle
  31 .Fa L .
  32 After
  33 .Fn Lfree ,
  34 calls to other
  35 .Sy libproc
  36 routines which leverage information from the handle
  37 .Fa L
  38 will no longer work as the handle has been invalidated.
  39 .Pp
  40 The state of the thread controlled by
  41 .Fa L
  42 is not affected by the call to
  43 .Fn Lfree .
  44 The thread's state will not transition from running to stopped or
  45 vice-versa.
  46 It will retain its state prior to the call to
  47 .Fn Lfree .
  48 .Sh INTERFACE STABILITY
  49 .Sy Uncommitted
  50 .Sh MT-LEVEL
  51 .Sy MT-Safe
  52 .Sh SEE ALSO
  53 .Xr libproc 3LIB ,
  54 .Xr Lgrab 3PROC