share/man/man9/g_provider_by_name.9

   1 .\"
   2 .\" Copyright (c) 2004 Pawel Jakub Dawidek <pjd@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd January 16, 2004
  28 .Dt G_PROVIDER_BY_NAME 9
  29 .Os
  30 .Sh NAME
  31 .Nm g_provider_by_name
  32 .Nd "find GEOM provider with given name"
  33 .Sh SYNOPSIS
  34 .In geom/geom.h
  35 .Ft "struct g_provider *"
  36 .Fn g_provider_by_name "const char *name"
  37 .Sh DESCRIPTION
  38 The
  39 .Fn g_provider_by_name
  40 function searches for a provider called
  41 .Fa name
  42 and returns the structure
  43 .Vt g_provider
  44 bound to it.
  45 Argument
  46 .Fa name
  47 should be a name, not a full path (i.e.,
  48 .Dq Pa da0 ,
  49 instead of
  50 .Dq Pa /dev/da0 ) .
  51 .Sh RESTRICTIONS/CONDITIONS
  52 The topology lock has to be held.
  53 .Sh RETURN VALUES
  54 The
  55 .Fn g_provider_by_name
  56 function
  57 returns a pointer to the provider called
  58 .Fa name
  59 or
  60 .Dv NULL
  61 if there is no such provider.
  62 .Sh SEE ALSO
  63 .Xr geom 4 ,
  64 .Xr DECLARE_GEOM_CLASS 9 ,
  65 .Xr g_access 9 ,
  66 .Xr g_attach 9 ,
  67 .Xr g_bio 9 ,
  68 .Xr g_consumer 9 ,
  69 .Xr g_data 9 ,
  70 .Xr g_event 9 ,
  71 .Xr g_geom 9 ,
  72 .Xr g_provider 9 ,
  73 .Xr g_wither_geom 9
  74 .Sh AUTHORS
  75 .An -nosplit
  76 This manual page was written by
  77 .An Pawel Jakub Dawidek Aq pjd@FreeBSD.org .