share/man/man3mpapi/MP_FreeOidList.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_FREEOIDLIST 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_FreeOidList \- free up memory
  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_FreeOidList\fR(\fBMP_OID_LIST\fR \fI*pOidList\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIpOidList\fR\fR
  24 .ad
  25 .RS 12n
  26 A pointer to an object ID list returned by an MP API.  With a successful
  27 return, the allocated memory is freed.
  28 .sp
  29 The client will free all \fBMP_OID_LIST\fR structures returned by any API by
  30 using this function.
  31 .RE
  32
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 The \fBMP_FreeOidList()\fR function frees memory returned by an MP API.
  37 .SH RETURN VALUES
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  42 .ad
  43 .sp .6
  44 .RS 4n
  45 The \fIpOidList\fR is null or specifies a memory area to which data cannot be
  46 written.
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBMP_STATUS_SUCCESS\fR\fR
  53 .ad
  54 .sp .6
  55 .RS 4n
  56 The operation is successful.
  57 .RE
  58
  59 .SH ATTRIBUTES
  60 .sp
  61 .LP
  62 See \fBattributes\fR(5) for descriptions of the following attributes:
  63 .sp
  64
  65 .sp
  66 .TS
  67 box;
  68 c | c
  69 l | l .
  70 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  71 _
  72 Interface Stability     T{
  73 Standard: ANSI INCITS 412 Multipath Management API
  74 T}
  75 _
  76 MT-Level        Safe
  77 .TE
  78
  79 .SH SEE ALSO
  80 .sp
  81 .LP
  82 \fBlibMPAPI\fR(3LIB), \fBattributes\fR(5)
  83 .sp
  84 .LP
  85 \fIMultipath Management API Version 1.0\fR