share/man/man2/sysfs.2

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1997, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH SYSFS 2 "Jul 5, 1990"
   7 .SH NAME
   8 sysfs \- get file system type information
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/fstyp.h>
  13 #include <sys/fsid.h>
  14
  15 \fBint\fR \fBsysfs\fR(\fBint\fR \fIopcode\fR, \fBconst char *\fR\fIfsname\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBint\fR \fBsysfs\fR(\fBint\fR \fIopcode\fR, \fBint\fR \fIfs_index\fR, \fBchar *\fR\fIbuf\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBsysfs\fR(\fBint\fR \fIopcode\fR);
  26 .fi
  27
  28 .SH DESCRIPTION
  29 .sp
  30 .LP
  31 The \fBsysfs()\fR function returns information about the file system types
  32 configured  in the system.  The number of arguments accepted by \fBsysfs()\fR
  33 depends on the \fIopcode\fR argument, which can take the following values:
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fBGETFSIND\fR\fR
  38 .ad
  39 .RS 13n
  40 Translate \fIfsname\fR, a null-terminated file-system type identifier, into a
  41 file-system type index.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fBGETFSTYP\fR\fR
  48 .ad
  49 .RS 13n
  50 Translate \fIfs_index\fR, a file-system type index, into a null-terminated
  51 file-system type identifier and write it into the buffer pointed to by
  52 \fIbuf\fR, which must be at least of size \fBFSTYPSZ\fR as defined in
  53 <\fBsys/fstyp.h\fR>.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBGETNFSTYP\fR\fR
  60 .ad
  61 .RS 13n
  62 Return the total number of file system types configured in the system.
  63 .RE
  64
  65 .SH RETURN VALUES
  66 .sp
  67 .LP
  68 Upon successful completion, the value returned depends upon the \fIopcode\fR
  69 argument as follows:
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBGETFSIND\fR\fR
  74 .ad
  75 .RS 13n
  76 the file-system type index
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBGETFSTYP\fR\fR
  83 .ad
  84 .RS 13n
  85 \fB0\fR
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBGETNFSTYP\fR\fR
  92 .ad
  93 .RS 13n
  94 the number of file system types configured
  95 .RE
  96
  97 .sp
  98 .LP
  99 Otherwise, \fB\(mi1\fR is returned  and \fBerrno\fR is set to indicate the
 100 error.
 101 .SH ERRORS
 102 .sp
 103 .LP
 104 The \fBsysfs()\fR function will fail if:
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBEFAULT\fR\fR
 109 .ad
 110 .RS 10n
 111 The \fIbuf\fR or \fIfsname\fR argument points to an illegal address.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBEINVAL\fR\fR
 118 .ad
 119 .RS 10n
 120 The \fIfsname\fR argument points to an invalid file-system identifier; the
 121 \fIfs_index\fR argument is 0 or invalid; or the \fIopcode\fR argument is
 122 invalid.
 123 .RE
 124