share/man/man9/vn_isdisk.9

   1 .\"
   2 .\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. 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(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  16 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  17 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18 .\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
  19 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  20 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22 .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  25 .\" DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd July 9, 2001
  30 .Dt VN_ISDISK 9
  31 .Os
  32 .Sh NAME
  33 .Nm vn_isdisk
  34 .Nd "checks if a vnode represents a disk"
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/vnode.h
  38 .Ft int
  39 .Fn vn_isdisk "struct vnode *vp" "int *errp"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn vn_isdisk
  43 function checks to see if
  44 .Fa vp
  45 represents a disk.
  46 In order for
  47 .Fa vp
  48 to be a disk,
  49 it must be a character device,
  50 .Va v_rdev
  51 must be valid, and the
  52 .Vt cdevsw
  53 entry's
  54 .Va flags
  55 must have
  56 .Dv D_DISK
  57 set.
  58 .Pp
  59 Its arguments are:
  60 .Bl -tag -width ".Fa errp"
  61 .It Fa vp
  62 The vnode to check.
  63 .It Fa errp
  64 An integer pointer to store the error number in if the call fails.
  65 .El
  66 .Sh RETURN VALUES
  67 If the vnode represents a disk, 1 is returned; otherwise, 0
  68 is returned and
  69 .Fa errp
  70 will contain the error number.
  71 .Sh AUTHORS
  72 This manual page was written by
  73 .An Chad David Aq davidc@acns.ab.ca .