share/man/man3mpapi/MP_DeregisterPlugin.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_DEREGISTERPLUGIN 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_DeregisterPlugin \- deregister a plugin
  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_DeregisterPlugin\fR(\fBMP_WCHAR\fR \fI*pPluginId\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIpPluginId\fR\fR
  24 .ad
  25 .RS 13n
  26 A pointer to a Plugin ID previously registered using the
  27 \fBMP_RegisterPlugin\fR(3MPAPI) API.
  28 .RE
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 The \fBMP_DeregisterPlugin()\fR function deregisters a plugin from the common
  34 library.
  35 .sp
  36 .LP
  37 The plugin will no longer be invoked by the common library. This API does not
  38 dynamically remove the plugin from a running library instance. Instead, it
  39 prevents an application that is currently not using a plugin from accessing the
  40 plugin. This is generally the behavior expected from dynamically loaded
  41 modules.
  42 .SH RETURN VALUES
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  47 .ad
  48 .sp .6
  49 .RS 4n
  50 The \fIpPluginId\fR parameter is null or specifies a memory area that is not
  51 executable.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBMP_STATUS_UNKNOWN_FN\fR\fR
  58 .ad
  59 .sp .6
  60 .RS 4n
  61 The \fIpPluginId\fR parameter is not the same as a previously registered
  62 function.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBMP_STATUS_SUCCESS\fR\fR
  69 .ad
  70 .sp .6
  71 .RS 4n
  72 The \fIpPluginId\fR parameter is deregistered successfully.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBMP_STATUS_FAILED\fR\fR
  79 .ad
  80 .sp .6
  81 .RS 4n
  82 The \fIpPluginId\fRparameter deregistration is not possible at this time
  83 .RE
  84
  85 .SH FILES
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB/etc/mpapi.conf\fR\fR
  90 .ad
  91 .RS 19n
  92 MPAPI library configuration file
  93 .RE
  94
  95 .SH ATTRIBUTES
  96 .sp
  97 .LP
  98 See \fBattributes\fR(5) for descriptions of the following attributes:
  99 .sp
 100
 101 .sp
 102 .TS
 103 box;
 104 c | c
 105 l | l .
 106 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 107 _
 108 Interface Stability     T{
 109 Standard: ANSI INCITS 412 Multipath Management API
 110 T}
 111 _
 112 MT-Level        Safe
 113 .TE
 114
 115 .SH SEE ALSO
 116 .sp
 117 .LP
 118 \fBlibMPAPI\fR(3LIB), \fBMP_RegisterPlugin\fR(3MPAPI), \fBmpapi.conf\fR(4),
 119 \fBattributes\fR(5)
 120 .sp
 121 .LP
 122 \fIMultipath Management API Version 1.0\fR