Current File : //usr/share/man/man3mpapi/MP_DeregisterPlugin.3mpapi

'\" te
.\" Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
.\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
.TH MP_DeregisterPlugin 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions"
.SH NAME
MP_DeregisterPlugin \- deregister a plugin
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <mpapi.h>

\fBMP_STATUS\fR \fBMP_DeregisterPlugin\fR(\fBMP_WCHAR\fR \fI*pPluginId\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIpPluginId\fR\fR
.ad
.RS 13n
.rt  
A pointer to a Plugin ID previously registered using the \fBMP_RegisterPlugin\fR(3MPAPI) API.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBMP_DeregisterPlugin()\fR function deregisters a plugin from the common library.
.sp
.LP
The plugin will no longer be invoked by the common library. This API does not dynamically remove the plugin from a running library instance. Instead, it prevents an application that is currently not using a plugin from accessing the plugin. This is generally the behavior expected from dynamically loaded modules.
.SH RETURN VALUES
.sp
.ne 2
.mk
.na
\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
.ad
.sp .6
.RS 4n
The \fIpPluginId\fR parameter is null or specifies a memory area that is not executable.
.RE

.sp
.ne 2
.mk
.na
\fB\fBMP_STATUS_UNKNOWN_FN\fR\fR
.ad
.sp .6
.RS 4n
The \fIpPluginId\fR parameter is not the same as a previously registered function.
.RE

.sp
.ne 2
.mk
.na
\fB\fBMP_STATUS_SUCCESS\fR\fR
.ad
.sp .6
.RS 4n
The \fIpPluginId\fR parameter is deregistered successfully.
.RE

.sp
.ne 2
.mk
.na
\fB\fBMP_STATUS_FAILED\fR\fR
.ad
.sp .6
.RS 4n
The \fIpPluginId\fRparameter deregistration is not possible at this time
.RE

.SH FILES
.sp
.ne 2
.mk
.na
\fB\fB/etc/mpapi.conf\fR\fR
.ad
.RS 19n
.rt  
MPAPI library configuration file
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelSafe
_
StandardANSI INCITS 412 Multipath Management API
.TE

.SH SEE ALSO
.sp
.LP
\fBlibMPAPI\fR(3LIB), \fBMP_RegisterPlugin\fR(3MPAPI), \fBmpapi.conf\fR(4), \fBattributes\fR(5)
.sp
.LP
\fIMultipath Management API Version 1.0\fR