xref: /illumos-gate/usr/src/man/man3mpapi/MP_FreeOidList.3mpapi (revision 37e2cd25d56b334a2403f2540a0b0a1e6a40bcd1)
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_FREEOIDLIST 3MPAPI "Feb 15, 2006"
NAME
MP_FreeOidList - free up memory
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -lMPAPI [ library.\|.\|. ]
#include <mpapi.h>

MP_STATUS MP_FreeOidList(MP_OID_LIST *pOidList);
PARAMETERS
pOidList

A pointer to an object ID list returned by an MP API. With a successful return, the allocated memory is freed. The client will free all MP_OID_LIST structures returned by any API by using this function.

DESCRIPTION

The MP_FreeOidList() function frees memory returned by an MP API.

RETURN VALUES
MP_STATUS_INVALID_PARAMETER

The pOidList is null or specifies a memory area to which data cannot be written.

MP_STATUS_SUCCESS

The operation is successful.

ATTRIBUTES

See attributes(7) 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), attributes (7)

Multipath Management API Version 1.0