blob: 2b391005251dcdc9059f75db5cf3759e86f4308a [file] [log] [blame]
.TH 3 2005-06-09 "sfcc" "SFCBroker Client Library"
CMCIClientFT.getInstance() \- Get class instance
.B #include <cmci.h>
.BI CMPIInstance *
.BI CMCIClientFT.getInstance (CMCIClient* cl,
.BI CMPIObjectPath* op,
.BI CMPIFlags flags,
.BI char** properties,
.BI CMPIStatus* rc);
Get class instance using \fIop\fP as reference. The content of the returned
class instance structure can be controled using the \fIflags\fP parameter.
Arguments are the client object pointer \fIcl\fP, ObjectPath object
pointer \fIop\fP that contains namespace and classname components,
\fIflags\fP to affect the returned class instance structure content,
\fIproperties\fP array, and \fIrc\fP which returns the operation status
(suppressed when NULL).
The \fIflags\fP argument is a bit mask that can contain combinations of
the following flags - \fICMPI_FLAG_LocalOnly\fP, \fICMPI_FLAG_IncludeQualifiers\fP, and \fICMPI_FLAG_IncludeClassOrigin\fP.
The \fIproperties\fP array defines what properties should be returned
for the class.
If this argument is not NULL, only the class properties in the list are
If it's NULL all class properties are returned.
When successful the \fBCMCIClientFT.getInstance()\fP function returns a pointer
to a CMPIInstance object and sets a successful status code for \fIrc\fR.
When unsuccessful it returns NULL and sets the \fIrc\fP argument with the
error code and and corresponding error string.
Common Manageability Programming Interface (CMPI) - OpenGroup,
CMCIClient(3), CMPIInstance(3), CMPIObjectPath(3), CMPIFlags(3),