usr/src/man/man3mpapi/MP_RegisterPlugin.3mpapi

   1 '\" te
   2 .\" Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
   3 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH MP_REGISTERPLUGIN 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_RegisterPlugin \- register a plugin with the common library
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <mpapi.h>
  15
  16 \fBMP_STATUS\fR \fBMP_RegisterPlugin\fR(\fBMP_WCHAR\fR \fI*pPluginId\fR,
  17      \fBMP_CHAR\fR \fI*pFileName\fR);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fIpPluginId\fR\fR
  25 .ad
  26 .RS 13n
  27 A pointer to the key name shall be the reversed domain name of the vendor
  28 followed by a ".", followed by the vendor-specific name for the plugin that
  29 uniquely identifies it.
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIpFileName\fR\fR
  36 .ad
  37 .RS 13n
  38 The full path name of the plugin library.
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 The \fBMP_RegisterPlugin()\fR function registers a plugin with the common
  45 library. The current implementation adds an entry to the \fB/etc/mpapi.conf\fR
  46 file.
  47 .sp
  48 .LP
  49 Unlike some other APIs, this API is implemented entirely in the common library.
  50 It must be called before a plugin is invoked by the common library.
  51 .sp
  52 .LP
  53 This API does not impact dynamically add or change plugins bound to a running
  54 library instance. Instead, it causes an application that is currently not using
  55 a plugin to access the specified plugin on future calls to the common library.
  56 This is generally the behavior expected from dynamically loaded modules.
  57 .sp
  58 .LP
  59 This API is typically called by a plugin's installation software to inform the
  60 common library of the path for the plugin library.
  61 .sp
  62 .LP
  63 It is not an error to re-register a plugin. However,  a plugin has only one
  64 registration. The first call to deregister a plugin will deregister it no
  65 matter how many calls to register the plugin have been made.
  66 .sp
  67 .LP
  68 A vendor may register multiple plugins by using separate plugin IDs and
  69 filenames.
  70 .SH RETURN VALUES
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  75 .ad
  76 .sp .6
  77 .RS 4n
  78 The \fIpFileName\fR does not exist.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBMP_STATUS_SUCCESS\fR\fR
  85 .ad
  86 .sp .6
  87 .RS 4n
  88 The operation is successful.
  89 .RE
  90
  91 .SH FILES
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fB/etc/mpapi.conf\fR\fR
  96 .ad
  97 .RS 19n
  98 MPAPI library configuration file
  99 .RE
 100
 101 .SH ATTRIBUTES
 102 .sp
 103 .LP
 104 See \fBattributes\fR(5) for descriptions of the following attributes:
 105 .sp
 106
 107 .sp
 108 .TS
 109 box;
 110 c | c
 111 l | l .
 112 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 113 _
 114 Interface Stability     T{
 115 Standard: ANSI INCITS 412 Multipath Management API
 116 T}
 117 _
 118 MT-Level        Safe
 119 .TE
 120
 121 .SH SEE ALSO
 122 .sp
 123 .LP
 124 \fBlibMPAPI\fR(3LIB), \fBMP_DeregisterPlugin\fR(3MPAPI), \fBmpapi.conf\fR(4),
 125 \fBattributes\fR(5)
 126 .sp
 127 .LP
 128 \fIMultipath Management API Version 1.0\fR