bsd/man/man2/getlcid.2

   1 .\" Copyright (c) 2005 SPARTA, Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .\" Note: The date here should be updated whenever a non-trivial
  28 .\" change is made to the manual page.
  29 .Dd May 5, 2005
  30 .Dt GETLCID 2
  31 .Os
  32 .Sh NAME
  33 .Nm getlcid
  34 .Nd "get login context"
  35 .Sh SYNOPSIS
  36 .In sys/lctx.h
  37 .Ft pid_t
  38 .Fn getlcid "pid_t pid"
  39 .Sh DESCRIPTION
  40 The login context of the process identified by
  41 .Fa pid
  42 is returned by
  43 .Fn getlcid .
  44 If
  45 .Fa pid
  46 is zero,
  47 .Fn getlcid
  48 returns the login context of the current process.
  49 .Pp
  50 Login contexts are used for tracking processes that originated from a users
  51 login session.  A login context is inherited via
  52 .Fn fork
  53 or by explicit creation using the
  54 .Fn setlcid
  55 call.
  56 .Sh RETURN VALUES
  57 If successful,
  58 .Fn getlcid
  59 returns a non-negative integer, the Login Context ID; otherwise the
  60 value \-1 is returned and the global variable
  61 .Fa errno
  62 is set to indicate
  63 the error.
  64 .Sh ERRORS
  65 The
  66 .Fn getlcid
  67 function will fail if:
  68 .Bl -tag -width Er
  69 .It Bq Er EPERM
  70 Operation not permitted.
  71 .It Bq Er ESRCH
  72 No such process.
  73 .It Bq Er ENOATTR
  74 Attribute not found.
  75 .El
  76 .Sh SEE ALSO
  77 .Xr setlcid 2
  78 .Sh HISTORY
  79 The
  80 .Nm
  81 manual page
  82 first appeared in
  83 .Fx 6.0 .
  84 .Sh AUTHORS
  85 This
  86 manual page was written by
  87 .An Matthew N. Dodd Aq mdodd@FreeBSD.org .