share/man/man3proc/proc_str2flt.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 PROC_STR2FLT 3PROC
  16 .Os
  17 .Sh NAME
  18 .Nm proc_str2flt ,
  19 .Nm proc_str2sig ,
  20 .Nm proc_str2sys
  21 .Nd convert a string to a fault, signal, or system call
  22 .Sh SYNOPSIS
  23 .Lb libproc
  24 .In libproc.h
  25 .Ft int
  26 .Fo proc_str2flt
  27 .Fa "const char *str"
  28 .Fa "int *fltnum"
  29 .Fc
  30 .Ft int
  31 .Fo proc_str2sig
  32 .Fa "const char *str"
  33 .Fa "int *signum"
  34 .Fc
  35 .Ft int
  36 .Fo proc_str2sys
  37 .Fa "const char *sys"
  38 .Fa "int *sysnum"
  39 .Fc
  40 .Sh DESCRIPTION
  41 The
  42 .Fn proc_str2flt ,
  43 .Fn proc_str2sig ,
  44 and
  45 .Fn proc_str2sys
  46 functions convert a string into the corresponding fault, signal, and
  47 system call number respectively and stores the resulting value in
  48 .Fa fltnum ,
  49 .Fa signum ,
  50 or
  51 .Fa sysnum
  52 respectively.
  53 .Sh RETURN VALUES
  54 Upon successful completion, the
  55 .Fn proc_str2flt ,
  56 .Fn proc_str2sig ,
  57 and
  58 .Fn proc_str2sys
  59 functions return
  60 .Sy 0
  61 and update
  62 .Fa fltnum ,
  63 .Fa signum ,
  64 and
  65 .Fa sysnum
  66 respectively.
  67 Otherwise,
  68 .Sy -1
  69 is returned to indicate that a conversion could not take place.
  70 .Sh INTERFACE STABILITY
  71 .Sy Uncommitted
  72 .Sh MT-LEVEL
  73 .Sy MT-Safe
  74 .Sh SEE ALSO
  75 .Xr libproc 3LIB ,
  76 .Xr proc_fltname 3PROC ,
  77 .Xr proc_fltset2str 3PROC ,
  78 .Xr proc_signame 3PROC ,
  79 .Xr proc_sigset2str 3PROC ,
  80 .Xr proc_str2fltset 3PROC ,
  81 .Xr proc_str2sigset 3PROC ,
  82 .Xr proc_str2sysset 3PROC ,
  83 .Xr proc_sysset2str 3PROC ,
  84 .Xr proc 4