usr/src/man/man3mpapi/MP_CompareOIDs.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_COMPAREOIDS 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_CompareOIDs \- compare two object IDs
  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_CompareOIDs\fR(\fBMP_OID\fR \fIoid1\fR, \fBMP_OID\fR \fIoid2\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIoid1\fR\fR
  24 .ad
  25 .RS 8n
  26 An object ID that has type MP_OIDs for two objects to compare.
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIoid2\fR\fR
  33 .ad
  34 .RS 8n
  35 An object ID that has type MP_OIDs for two objects to compare.
  36 .RE
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBMP_CompareOIDs()\fR function compares two object IDs (OIDs) for equality
  42 to see whether they refer to the same object. The fields in the two object IDs
  43 are compared field-by-field for equality.
  44 .SH RETURN VALUES
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBMP_STATUS_FAILED\fR\fR
  49 .ad
  50 .RS 20n
  51 The object IDs do not compare.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBMP_STATUS_SUCCESS\fR\fR
  58 .ad
  59 .RS 21n
  60 The two object IDs refer to the same object.
  61 .RE
  62
  63 .SH ATTRIBUTES
  64 .sp
  65 .LP
  66 See \fBattributes\fR(5) for descriptions of the following attributes:
  67 .sp
  68
  69 .sp
  70 .TS
  71 box;
  72 c | c
  73 l | l .
  74 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  75 _
  76 Interface Stability     T{
  77 Standard: ANSI INCITS 412 Multipath Management API
  78 T}
  79 _
  80 MT-Level        Safe
  81 .TE
  82
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBlibMPAPI\fR(3LIB), \fBattributes\fR(5)
  87 .sp
  88 .LP
  89 \fIMultipath Management API Version 1.0\fR