← Back to branch summary

~ubuntu-branches/ubuntu/utopic/sblim-sfcc/utopic-proposed

« back to all changes in this revision

Viewing changes to .pc/fix-manpage-mismatch.patch/man/man3/CMCIClientFT.enumInstances.3

  • Committer: Package Import Robot
  • Author(s): Kent Baxley
  • Date: 2014-06-25 13:34:21 UTC
  • mfrom: (1.1.6)
  • Revision ID: package-import@ubuntu.com-20140625133421-6a2arkqw06znji3u
Tags: 2.2.7-0ubuntu1
https://launchpad.net/bugs/1335941
* New upstream release (LP: #1335941). 
* New Features:
 - [bugs:#2692] SFCC: SfcbLocal interface should expose markHeap() and releaseHeap()

 Bugs:
 - [bugs:#2728] Missing tag definition for REFARRAY
 - [bugs:#2729] Improper type handling for EmbeddedObject in PARAMVALUE
 - [bugs:#2730] More memory leaks in backend/cimxml/grammer.c
 

Show diffs side-by-side

added added

removed removed

Lines of Context:
.pc/fix-manpage-mismatch.patch/man/man3/CMCIClientFT.enumInstances.3
 
1
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
 
2
.SH NAME
 
3
CMCIClientFT.enumInstances() \- Enumerate instances of a class
 
4
.SH SYNOPSIS
 
5
.nf
 
6
.B #include <cmci.h>
 
7
.sp
 
8
.BI CMPIEnumeration *
 
9
.BI CMCIClientFT.enumInstances (CMCIClient* cl,
 
10
.br
 
11
.BI                             CMPIObjectPath* op,
 
12
.br
 
13
.BI                             CMPIFlags flags,
 
14
.br
 
15
.BI                             char** properties,
 
16
.br
 
17
.BI                             CMPIStatus* rc);
 
18
.br
 
19
.sp
 
20
.fi
 
21
.SH DESCRIPTION
 
22
Enumerate Instances of the class (and subclasses) defined by \fIop\fP.
 
23
The instance structure and inheritance scope can be controled using the
 
24
\fIflags\fP argument.
 
25
.PP
 
26
Arguments are the client object pointer \fIcl\fP, an ObjectPath object 
 
27
pointer \fIop\fP with the reference that contains namespace and classname
 
28
components,
 
29
\fIflags\fP that affect the content of the returned class instance structures,
 
30
a \fIproperties\fP array, and \fIrc\fP which returns the operation status 
 
31
(suppressed when NULL).
 
32
.PP
 
33
The \fIflags\fP argument is a bit mask that can contains the following 
 
34
flags - \fICMPI_FLAG_LocalOnly\fP, \fICMPI_FLAG_DeepInheritance\fP, 
 
35
\fICMPI_FLAG_IncludeQualifiers\fP and \fICMPI_FLAG_IncludeClassOrigin\fP.
 
36
.SH "RETURN VALUE"
 
37
When successful the \fBCMCIClientFT.enumInstances()\fP function returns
 
38
a pointer to a CMPIEnumeration object that contains the class instances 
 
39
found for the class and sets a successful operation status code in \fIrc\fR.
 
40
When unsuccessful it returns a NULL pointer and sets the operation 
 
41
status error code and corresponding error string in \fIrc\fP.
 
42
.SH "ERRORS"
 
43
.sp
 
44
.SH "EXAMPLES"
 
45
   CMCIClient *cc;
 
46
   CMPIObjectPath * objectpath;
 
47
   CMPIInstance * instance;
 
48
   CMPIEnumeration * enumeration;
 
49
   CMPIStatus status;
 
50
 
 
51
   /* Setup a conncetion to the CIMOM */   
 
52
   cc = cmciConnect("localhost", NULL, NULL, NULL, NULL, NULL);
 
53
 
 
54
   objectpath = newCMPIObjectPath("root/cimv2", NULL, NULL);
 
55
   enumeration = cc->ft->enumInstances(cc, objectpath, 0, NULL, &status);
 
56
 
 
57
   if (!status.rc) {
 
58
        fprintf(stderr, "operation error code %d description %s\n",
 
59
                        status.rc, status.msg->hdl);
 
60
        abort();
 
61
   }
 
62
.SH "CONFORMING TO"
 
63
.sp
 
64
.SH "SEE ALSO"
 
65
Common Manageability Programming Interface (CMPI) - OpenGroup,
 
66
.br
 
67
CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIFlags(3),
 
68
CMPIStatus(3)