xref: /illumos-gate/usr/src/man/man3mpapi/MP_DeregisterPlugin.3mpapi (revision 78f5fe539528ce4afb4d8137ae7f8ff44765b467)
te
Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
MP_DEREGISTERPLUGIN 3MPAPI "June 13, 2021"
NAME
MP_DeregisterPlugin - deregister a plugin
SYNOPSIS
cc [ flag.\|.\|. ] file.\|.\|. -lMPAPI [ library.\|.\|. ]
#include <mpapi.h>

MP_STATUS MP_DeregisterPlugin(MP_WCHAR *pPluginId);
PARAMETERS
pPluginId

A pointer to a Plugin ID previously registered using the MP_RegisterPlugin(3MPAPI) API.

DESCRIPTION
The MP_DeregisterPlugin() function deregisters a plugin from the common library.

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.

RETURN VALUES
MP_STATUS_INVALID_PARAMETER

The pPluginId parameter is null or specifies a memory area that is not executable.

MP_STATUS_UNKNOWN_FN

The pPluginId parameter is not the same as a previously registered function.

MP_STATUS_SUCCESS

The pPluginId parameter is deregistered successfully.

MP_STATUS_FAILED

The pPluginId parameter deregistration is not possible at this time

FILES
/etc/mpapi.conf

MPAPI library configuration file

ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability
Standard: ANSI INCITS 412 Multipath Management API
MT-Level Safe
SEE ALSO
libMPAPI(3LIB), MP_RegisterPlugin(3MPAPI), mpapi.conf(4), attributes(5)

Multipath Management API Version 1.0