[Sblim-commit] sfcc/man/man3 CMCIClient.3,NONE,1.1 CMCIClientFT.associatorNames.3,NONE,1.1 CMCIClien

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/sblim/sfcc/man/man3
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2810

Added Files:
	CMCIClient.3 CMCIClientFT.associatorNames.3 
	CMCIClientFT.associators.3 CMCIClientFT.createInstance.3 
	CMCIClientFT.deleteInstance.3 CMCIClientFT.enumClassNames.3 
	CMCIClientFT.enumClasses.3 CMCIClientFT.enumInstanceNames.3 
	CMCIClientFT.enumInstances.3 CMCIClientFT.execQuery.3 
	CMCIClientFT.getClass.3 CMCIClientFT.getInstance.3 
	CMCIClientFT.getProperty.3 CMCIClientFT.invokeMethod.3 
	CMCIClientFT.referenceNames.3 CMCIClientFT.references.3 
	CMCIClientFT.setInstance.3 CMCIClientFT.setProperty.3 
	CMPIArgs.3 CMPIEnumeration.3 CMPIInstance.3 CMPIObjectPath.3 
	CMPIStatus.3 CMPIString.3 CMPIValue.3 cmciConnect.3 
Log Message:
added man pages

--- NEW FILE: CMCIClient.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClient \- CIMOM Client Library object
.SH SYNOPSIS
.nf
.PP
\fC#include <cmci.h>\fP
.PP
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "void * \fBhdl\fP"
.br
.RI "\fIOpaque pointer to specific implementation data. \fP"
.br
.ti -1c
.RI "\fBCMCIClientFT\fP * \fBft\fP"
.br
.RI "\fIPointer to the Args Function Table. \fP"
.SH "Class methods"
.br
.ti -1c
.RI "\fBCMPIEnumeration\fP * \fBenumInstanceNames\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIInstance\fP * \fBgetInstance\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, \fBCMPIFlags\fP flags, char **properties, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIObjectPath\fP * \fBcreateInstance\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, \fBCMPIInstance\fP *inst, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIStatus\fP \fBsetInstance\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, \fBCMPIInstance\fP *inst, \fBCMPIFlags\fP flags, char **properties)"
.br
.ti -1c
.RI "\fBCMPIStatus\fP \fBdeleteInstance\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop)"
.br
.ti -1c
.RI "\fBCMPIEnumeration\fP * \fBexecQuery\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, const char *query, const char *lang, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIEnumeration\fP * \fBenumInstances\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, \fBCMPIFlags\fP flags, char **properties, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIEnumeration\fP * \fBassociators\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, const char *assocClass, const char *resultClass, const char *role, const char *resultRole, \fBCMPIFlags\fP flags, char **properties, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIEnumeration\fP * \fBassociatorNames\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, const char *assocClass, const char *resultClass, const char *role, const char *resultRole, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIEnumeration\fP * \fBreferences\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, const char *resultClass, const char *role, \fBCMPIFlags\fP flags, char **properties, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIEnumeration\fP * \fBreferenceNames\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, const char *resultClass, const char *role, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIData\fP \fBinvokeMethod\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, const char *method, \fBCMPIArgs\fP *in, \fBCMPIArgs\fP *out, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIStatus\fP \fBsetProperty\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, const char *name, \fBCMPIValue\fP *value, \fBCMPIType\fP type)"
.br
.ti -1c
.RI "\fBCMPIData\fP \fBgetProperty\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, const char *name, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIConstClass\fP * \fBgetClass\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, \fBCMPIFlags\fP flags, char **properties, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIEnumeration\fP * \fBenumClassNames\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, \fBCMPIFlags\fP flags, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIEnumeration\fP * \fBenumClasses\fP (\fBCMCIClient\fP *mb, \fBCMPIObjectPath\fP *cop, \fBCMPIFlags\fP flags, \fBCMPIStatus\fP *rc)"
.br
.SH DESCRIPTION
Client library class that provides the methods for connecting to and 
accessing the CIMOM.
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClientFT.associatorNames(3), CMCIClientFT.associators(3),
.br
CMCIClientFT.createInstance(3), CMCIClientFT.deleteInstance(3),
.br
CMCIClientFT.enumClasses(3), CMCIClientFT.enumClassNames(3),
.br
CMCIClientFT.enumInstanceNames(3), CMCIClientFT.enumInstances(3),
.br
CMCIClientFT.execQuery(3), CMCIClientFT.getClass(3),
.br
CMCIClientFT.getInstance(3), CMCIClientFT.getProperty(3),
.br
CMCIClientFT.invokeMethod(3), CMCIClientFT.referenceNames(3),
.br
CMCIClientFT.references(3), CMCIClientFT.setInstance(3),
.br
CMCIClientFT.setProperty(3), cmciConnect(3)

--- NEW FILE: CMPIStatus.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMPIStatus \- CMPIStatus class implementation
.SH SYNOPSIS
.br
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBCMPIrc\fP \fBrc;\fP"
.br
.RI "\fIstatus code for operation. \fP"
.br
.ti -1c
.RI "\fBCMPIString\fP * \fBmsg;\fP"
.br
.RI "\fIString description for status code, when errors occur. \fP"
.in +1c
.SH METHODS
.br
.SH DESCRIPTION
Native CMPIStatus implementation. 

This is the native CMPIStatus implementation as used for remote providers. It reflects the well-defined interface of a regular CMPIStatus object, however, it works independently from the management broker.
.PP
It is part of a native broker implementation that simulates CMPI data types rather than interacting with the entities in a full-grown CIMOM.
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup

--- NEW FILE: CMCIClientFT.setInstance.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClientFT.setInstance() \- Replace class instance
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIStatus *
.BI CMCIClientFT.setInstance (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				CMPIFlags flags,
.br
.BI				char** properties,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Replace a class instance with \fIinst\fP using \fIop\fP as reference. 
The content of the returned class instance structure can be controled
using the \fIflags\fP parameter.
.PP
Arguments are the client object pointer \fIcl\fP, an 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).
.PP
The \fIflags\fP argument is a bit mask that can contain 
the following flag - \fICMPI_FLAG_IncludeQualifiers\fP.
.PP
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 
returned.
If it's NULL all class properties are returned.
.PP
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.setInstance()\fP function returns a
CMPIStatus object with a successful operation status code.
When unsuccessful it returns the operation error code and 
corresponding error string.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
.sp
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIStatus(3), CMPIObjectPath(3), CMPIFlags(3)

--- NEW FILE: CMPIObjectPath.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMPIObjectPath \- CMPIObjectPath class implementation
.SH SYNOPSIS
.br
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "int \fBvoid * hdl\fP
.br
Opaque pointer to class instance data.
.ti -1c
.RI "\fBCMPIObjectPathFT\fP * \fBft\fP"
.br
.RI "\fIPointer to the Args Function Table. \fP"
.in -1c
.SH METHODS
.ti -1c
.RI "\fBCMPIStatus\fP(* \fBrelease\fP )(\fBCMPIObjectPath\fP *op)"
.br
.RI "\fIThe ObjectPath object will not be used any further and may be freed by CMPI run time system. \fP"
.ti -1c
.RI "\fBCMPIObjectPath\fP *(* \fBclone\fP )(\fBCMPIObjectPath\fP *op, \fBCMPIStatus\fP *rc)"
.br
.RI "\fICreate an independent copy of this ObjectPath object. \fP"
.ti -1c
.RI "\fBCMPIStatus\fP(* \fBsetNameSpace\fP )(\fBCMPIObjectPath\fP *op, const char *ns)"
.br
.RI "\fISet/replace the namespace component. \fP"
.ti -1c
.RI "\fBCMPIString\fP *(* \fBgetNameSpace\fP )(\fBCMPIObjectPath\fP *op, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGet the namespace component. \fP"
.ti -1c
.RI "\fBCMPIStatus\fP(* \fBsetHostname\fP )(\fBCMPIObjectPath\fP *op, const char *hn)"
.br
.RI "\fISet/replace the hostname component. \fP"
.ti -1c
.RI "\fBCMPIString\fP *(* \fBgetHostname\fP )(\fBCMPIObjectPath\fP *op, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGet the hostname component. \fP"
.ti -1c
.RI "\fBCMPIStatus\fP(* \fBsetClassName\fP )(\fBCMPIObjectPath\fP *op, const char *cn)"
.br
.RI "\fISet/replace the classname component. \fP"
.ti -1c
.RI "\fBCMPIString\fP *(* \fBgetClassName\fP )(\fBCMPIObjectPath\fP *op, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGet the classname component. \fP"
.ti -1c
.RI "\fBCMPIStatus\fP(* \fBaddKey\fP )(\fBCMPIObjectPath\fP *op, const char *name, \fBCMPIValue\fP *value, \fBCMPIType\fP type)"
.br
.RI "\fIAdds/replaces a named key property. \fP"
.ti -1c
.RI "\fBCMPIData\fP(* \fBgetKey\fP )(\fBCMPIObjectPath\fP *op, const char *name, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGets a named key property value. \fP"
.ti -1c
.RI "\fBCMPIData\fP(* \fBgetKeyAt\fP )(\fBCMPIObjectPath\fP *op, unsigned int index, \fBCMPIString\fP **name, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGets a key property value defined by its index. \fP"
.ti -1c
.RI "unsigned int(* \fBgetKeyCount\fP )(\fBCMPIObjectPath\fP *op, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGets the number of key properties contained in this ObjectPath. \fP"
.ti -1c
.RI "\fBCMPIStatus\fP(* \fBsetNameSpaceFromObjectPath\fP )(\fBCMPIObjectPath\fP *op, \fBCMPIObjectPath\fP *src)"
.br
.RI "\fISet/replace namespace and classname components from <src>. \fP"
.ti -1c
.RI "\fBCMPIStatus\fP(* \fBsetHostAndNameSpaceFromObjectPath\fP )(\fBCMPIObjectPath\fP *op, \fBCMPIObjectPath\fP *src)"
.br
.RI "\fISet/replace hostname, namespace and classname components from <src>. \fP"
.ti -1c
.RI "\fBCMPIData\fP(* \fBgetClassQualifier\fP )(\fBCMPIObjectPath\fP *op, const char *qName, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGet class qualifier value. \fP"
.ti -1c
.RI "\fBCMPIData\fP(* \fBgetPropertyQualifier\fP )(\fBCMPIObjectPath\fP *op, const char *pName, const char *qName, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGet property qualifier value. \fP"
.ti -1c
.RI "\fBCMPIData\fP(* \fBgetMethodQualifier\fP )(\fBCMPIObjectPath\fP *op, const char *methodName, const char *qName, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGet method qualifier value. \fP"
.ti -1c
.RI "\fBCMPIData\fP(* \fBgetParameterQualifier\fP )(\fBCMPIObjectPath\fP *op, const char *mName, const char *pName, const char *qName, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGet method parameter quailifier value. \fP"
.ti -1c
.RI "\fBCMPIString\fP *(* \fBtoString\fP )(\fBCMPIObjectPath\fP *op, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGenerates a well formed string representation of this ObjectPath. \fP"
.in -1c
.SH DESCRIPTION
.PP 
Native CMPIObjectPath implementation. 

This is the native CMPIObjectPath implementation as used for remote providers. It reflects the well-defined interface of a regular CMPIObjectPath, however, it works independently from the management broker.
.PP
It is part of a native broker implementation that simulates CMPI data types rather than interacting with the entities in a full-grown CIMOM.
.SH Examples
.RI "\fBCMPIString * namespace = objpath->ft->getNameSpace(objectpath, NULL);\fP"
.br
.RI "\fBCMPIString * classname = objpath->ft->getClassName(objectpath, NULL);\fP"
.br
.RI "\fBint numkeys = objectpath->ft->getKeyCount(objectpath, NULL);\fP"

.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup

--- NEW FILE: CMCIClientFT.setProperty.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClientFT.setProperty() \- Set a named property value of an instance
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIStatus
.BI CMCIClientFT.setProperty (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				const char* name,
.br
.BI				CMPIValue* value,
.br
.BI				CMPIType type);
.br
.sp
.fi
.SH DESCRIPTION
Set the named property value of an instance identified by reference \fIop\fP.
.PP
Arguments are the client object pointer \fIcl\fP, an ObjectPath object 
pointer \fIop\fP with the namespace and classname to identify the instance,
a pointer to a string with the property name to set in \fIname\fP,
a pointer to the CMPIValue with the value to set in \fIvalue\fP,
and \fIrc\fP which returns the operation status (suppressed when NULL).
.PP
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.setProperty()\fP function returns
a CMPIStatus object with a successful operation status code set.
When unsuccessful it returns the CMPIStatus object with the error code 
and corresponding error string set.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
.sp
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIStatus(3), CMPIObjectPath(3), CMPIValue(3),
CMPIType(3)

--- NEW FILE: CMPIArgs.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMPIArgs \- CMPIArgs class implementation
.SH SYNOPSIS
.br
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "int \fBvoid * hdl\fP
.br
Opaque pointer to class instance data.
.ti -1c
.RI "\fBCMPIArgsFT\fP * \fBft\fP"
.br
.RI "\fIPointer to the Args Function Table. \fP"
.in -1c
.SH METHODS
.in +1c
.ti -1c
.RI "\fBCMPIStatus\fP \fBrelease\fP (\fBCMPIArgs\fP *args)"
.br
.ti -1c
.RI "\fBCMPIArgs\fP * \fBclone\fP (\fBCMPIArgs\fP *args, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIStatus\fP \fBaddArg\fP (\fBCMPIArgs\fP *args, char *name, \fBCMPIValue\fP *value, \fBCMPIType\fP type)"
.br
.ti -1c
.RI "\fBCMPIData\fP \fBgetArg\fP (\fBCMPIArgs\fP *args, char *name, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "\fBCMPIData\fP \fBgetArgAt\fP (\fBCMPIArgs\fP *args, unsigned int index, \fBCMPIString\fP **name, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "unsigned int \fBgetArgCount\fP (\fBCMPIArgs\fP *args, \fBCMPIStatus\fP *rc)"
.br
.in -1c
.SH DESCRIPTION
Native CMPIArgs implementation. 

This is the native CMPIArgs implementation as used for remote providers. It reflects the well-defined interface of a regular CMPIArgs object, however, it works independently from the management broker.
.PP
It is part of a native broker implementation that simulates CMPI data types rather than interacting with the entities in a full-grown CIMOM.
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup

--- NEW FILE: CMCIClientFT.associators.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClientFT.associators() \- Enumerate instances associated with an Instance
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIEnumeration *
.BI CMCIClientFT.associators (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				const char *assocClass,
.br
.BI				const char *resultClass,
.br
.BI				const char *role,
.br
.BI				const char *resultRole,
.br
.BI				CMPIFlags flags,
.br
.BI				char** properties,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Enumerate instances associated with the Instance defined by \fIop\fP reference.
.PP
Arguments are the client object pointer \fIcl\fP, an ObjectPath object 
pointer \fIop\fP with the reference that contains namespace and classname
components,
\fIassocClass\fP, where if it's not NULL is an association class name that 
is used to filter the returned set of instance objects by eliminating 
objects that aren't associated to the source object by an instance of 
this class or one of its subclasses,
\fIresultClass\fP, where if it's not NULL is a valid class name that 
is used to filter the returned set of Objects by eliminating objects that
aren't an Instance of this Class or one of its subclasses,
\fIrole\fP, where if it's not NULL is a valid property name that 
is used to filter the returned set of instance objects by eliminating
objects that aren't associated to the source object by an association 
where the source object plays the specified role, i.e. the name of the 
property in the association class that refers to the source object 
has to match the value of this parameter,
\fIresultRole\fP, where if it's not NULL is a valid property name that 
is used to filter the returned set of instance objects by eliminating 
objects that aren't associated to the source object by an association
where the returned object plays the specified role, i.e. the name of 
the property in the association class that refers to the returned object
has to match the value of this parameter,
\fIflags\fP that affect the content of the returned class instance structures,
a \fIproperties\fP array, and \fIrc\fP which returns the operation status 
(suppressed when NULL).
.PP
The \fIflags\fP argument is a bit mask that can contains the following flags - 
\fICMPI_FLAG_IncludeQualifiers\fP and \fICMPI_FLAG_IncludeClassOrigin\fP.
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.associators()\fP function returns
a pointer to a CMPIEnumeration object that contains the class instances 
found for the class that match the association criteria and sets a 
successful operation status code in \fIrc\fR.
When unsuccessful it returns a NULL pointer and sets the operation 
status error code and corresponding error string in \fIrc\fP.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
.sp
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIFlags(3),
CMPIStatus(3)

--- NEW FILE: CMCIClientFT.execQuery.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClientFT.execQuery() \- Query the enumeration of instances of a class
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIEnumeration *
.BI CMCIClientFT.execQuery (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				const char* query,
.br
.BI				const char* lang,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Query the enumeration of instances of the class (and subclasses) defined
by reference \fIop\fP using the \fIquery\fP expression.
.PP
Arguments are the client object pointer \fIcl\fP, an ObjectPath object 
pointer \fIop\fP with the reference that contains namespace and classname
components,
the query expression string pointer in \fIquery\fP,
the query language identifier string pointer in \fIlang\fP,
and \fIrc\fP which returns the operation status (suppressed when NULL).
.PP
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.execQuery()\fP function returns a
pointer to a CMPIEnumeration object that contains the class instances 
that match the query and sets a successful operation status code.
When unsuccessful it returns a NULL pointer and sets the operation 
status error code and corresponding error string in \fIrc\fP.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
.sp
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIStatus(3)

--- NEW FILE: CMPIString.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMPIString \- CMPIString class implementation
.SH SYNOPSIS
.br
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "int \fBvoid * hdl;\fP
.br
.RI "\fIOpaque pointer to class instance data. \fP"
.ti -1c
.RI "\fBCMPIStringFT\fP * \fBft;\fP"
.br
.RI "\fIPointer to the Args Function Table. \fP"
.in -1c
.SH METHODS
.in +1c
.ti -1c
.RI "\fBCMPIStatus\fP \fBrelease\fP (\fBCMPIString\fP *string)"
.br
.ti -1c
.RI "\fBCMPIString\fP * \fBclone\fP (\fBCMPIString\fP *string, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "char * \fBgetCharPtr\fP (\fBCMPIString\fP *string, \fBCMPIStatus\fP *rc)"
.br
.in -1c
.SH DESCRIPTION
.PP 
CMPIString class implementation, representing the Encapsulated String object. 

This is the native CMPIString implementation as used for remote providers. It reflects the well-defined interface of a regular CMPIString, however, it works independently from the management broker.
.PP
It is part of a native broker implementation that simulates CMPI data types rather than interacting with the entities in a full-grown CIMOM.
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup

--- NEW FILE: cmciConnect.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
cmciConnect() \- Create a CMCIClient object and connection
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMCIClient *
.BI cmciClient (const char* hostName, const char* hostPort, 
.br
.BI		const char* CimUsername, const char* CimPassword,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Create a CMCIClient object and initialize it with the CIMOM connection 
hostname and port, the security credentials to log into the CIMOM, and
the internals for sending requests and receiving responses from the CIMOM.
.PP
Arguments are the \fIhostName\fP and \fIhostPort\fP to connect, the 
\fICimUsername\fP and \fICimPassword credentials for authentication 
with the CIMOM, and a pointer to an object to receive the CMPIStatus
operation status.
.SH "RETURN VALUE"
When successful the \fIcmciConnect\fP function returns a pointer to a 
dynamically allocated and initialized CMCIClient object with a successful
operation status code set.
When unsuccessful it returns NULL and sets \fIrc\fP object with the error
code and corresponding error string.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
.nf
   CMCIClient *cc;

   /* Setup a local conncetion to the CIMOM */   
   cc = cmciConnect("localhost",NULL,NULL,NULL,NULL);
.fi
.sp
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIStatus(3)

--- NEW FILE: CMCIClientFT.enumClasses.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCICLientFT.enumClasses() \- Enumerate classes and subclasss
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIEnumeration *
.BI CMCIClientFT.enumClasses (CMCIClient* cl,
.br
				    CMPIObjectPath* op,
.br
				    CMPIFlags flags,
.br
				    CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Enumerate Classies using \fIop\fP as reference. The content of the returned
classes can be controled using the \fIflags\fP parameter.
.PP
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 structure content, 
and \fIrc\fP the CMPI return status (suppressed when NULL).
.PP
The \fIflags\fP argument is a bit mask that can contain the flags 
\fICMPI_FLAG_LocalOnly\fP, \fICMPI_FLAG_DeepInheritance\fP, 
\fICMPI_FLAG_IncludeQualifiers\fP, and \fICMPI_FLAG_IncludeClassOrigin\fP.
.PP
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.enumClasses()\fP function returns
a pointer to a CMPIEnumeration object that contains each enumerated class
and sets a successful status code
in \fIrc\fR.
When unsuccessful it returns NULL and sets the \fIrc\fP argument with the
error code and and corresponding error string.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
   CMCIClient *cc;
   CMPIObjectPath * objectpath;
   CMPIInstance * instance;
   CMPIEnumeration * enumeration;
   CMPIStatus status;

   /* Setup a conncetion to the CIMOM */   
   cc = cmciConnect("localhost",NULL,NULL,NULL,NULL);

   objectpath = newCMPIObjectPath("root/cimv2", NULL, NULL);
   enumeration = cc->ft->enumClasses(cc, objectpath, 0, &status);

   if (!status.rc) {
	fprintf(stderr, "operation error code %d description %s\n",
			status.rc, status.msg->hdl);
	abort();
   }
.fi
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIFlags(3), 
CMPIStatus(3)

--- NEW FILE: CMCIClientFT.associatorNames.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCICLientFT.associatorNames() \- Enumerate ObjectPaths associated with an Instance
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIEnumeration *
.BI CMCIClientFT.associatorNames (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				const char *assocClass,
.br
.BI				const char *resultClass,
.br
.BI				const char *role,
.br
.BI				const char *resultRole,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Enumerate ObjectPath references associated with the Instance defined 
by \fIop\fP reference.
.PP
Arguments are the client object pointer \fIcl\fP,
an ObjectPath object pointer \fIop\fP with the reference that contains
namespace and classname components,
\fIassocClass\fP, where if it's not NULL is an association class name that 
is used to filter the returned set of ObjectPath objects by eliminating 
objects that aren't associated to the source object by an instance of 
this class or one of its subclasses,
\fIresultClass\fP, where if it's not NULL is a valid class name that 
is used to filter the returned set of Objects by eliminating objects that
aren't an Instance of this Class or one of its subclasses,
\fIrole\fP, where if it's not NULL is a valid property name that 
is used to filter the returned set of ObjectPath objects by eliminating
objects that aren't associated to the source object by an association 
where the source object plays the specified role, i.e. the name of the 
property in the association class that refers to the source object 
has to match the value of this parameter,
\fIresultRole\fP, where if it's not NULL is a valid property name that 
is used to filter the returned set of ObjectPath objects by eliminating 
objects that aren't associated to the source object by an association
where the returned object plays the specified role, i.e. the name of 
the property in the association class that refers to the returned object
has to match the value of this parameter,
\fIrc\fP which returns the operation status (suppressed when NULL).
.PP
The \fIflags\fP argument is a bit mask that can contains the following flags - 
\fICMPI_FLAG_IncludeQualifiers\fP and \fICMPI_FLAG_IncludeClassOrigin\fP.
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.associatorNames()\fP function returns
a pointer to a CMPIEnumeration object that contains the ObjectPath objects
found for the class that match the association criteria and sets a 
successful operation status code in \fIrc\fR.
When unsuccessful it returns a NULL pointer and sets the operation 
status error code and corresponding error string in \fIrc\fP.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
.sp
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIStatus(3)

--- NEW FILE: CMCIClientFT.references.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClientFT.references() \- Enumerate association instances for a class instance
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIEnumeration *
.BI CMCIClientFT.references (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				const char *resultClass,
.br
.BI				const char *role,
.br
.BI				CMPIFlags flags,
.br
.BI				char** properties,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Enumerate association instances that refer to the Instance defined
by the \fIop\fP reference.
.PP
Arguments are the client object pointer \fIcl\fP, an ObjectPath object 
pointer \fIop\fP with the reference that contains namespace and classname
components,
\fIresultClass\fP, where if it's not NULL is a valid class name that 
is used to filter the returned set of Objects by eliminating objects that
aren't an Instance of this Class or one of its subclasses,
\fIrole\fP, where if it's not NULL is a valid property name that 
is used to filter the returned set of instance objects by eliminating
objects that aren't associated to the source object by an association 
where the source object plays the specified role, i.e. the name of the 
property in the association class that refers to the source object 
has to match the value of this parameter,
\fIflags\fP that affect the content of the returned class instance structures,
a \fIproperties\fP array, and \fIrc\fP which returns the operation status 
(suppressed when NULL).
.PP
The \fIflags\fP argument is a bit mask that can contains the following flags - 
\fICMPI_FLAG_IncludeQualifiers\fP and \fICMPI_FLAG_IncludeClassOrigin\fP.
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.references()\fP function returns
a pointer to a CMPIEnumeration object that contains the class association
instance objects found that match the association criteria, and sets a 
successful operation status code in \fIrc\fR.
When unsuccessful it returns a NULL pointer and sets the operation 
status error code and corresponding error string in \fIrc\fP.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
.sp
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIFlags(3),
CMPIStatus(3)

--- NEW FILE: CMCIClientFT.enumInstanceNames.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClientFT.enumInstanceNames() \- Enumerate instance names of a class
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIEnumeration *
.BI CMCIClientFT.enumInstanceNames (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Enumerate Instance Names of the class (and subclasses) defined by \fIop\fP.
.PP
Arguments are the client object pointer \fIcl\fP, an ObjectPath object 
pointer \fIop\fP with the reference that contains namespace and classname
components, and \fIrc\fP which returns the operation status (suppressed 
when NULL).
.PP
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.enumInstanceNames()\fP function returns
a pointer to a CMPIEnumeration object that contains strings for each instance
name found for the class and sets a successful operation status code 
in \fIrc\fR.
When unsuccessful it returns a NULL pointer and sets the operation 
status error code and corresponding error string in \fIrc\fP.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
   CMCIClient *cc;
   CMPIObjectPath * objectpath;
   CMPIInstance * instance;
   CMPIEnumeration * enumeration;
   CMPIStatus status;

   /* Setup a conncetion to the CIMOM */   
   cc = cmciConnect("localhost",NULL,NULL,NULL,NULL);

   objectpath = newCMPIObjectPath("root/cimv2", NULL, NULL);
   enumeration = cc->ft->enumInstanceNames(cc, objectpath, &status);

   if (!status.rc) {
	fprintf(stderr, "operation error code %d description %s\n",
			status.rc, status.msg->hdl);
	abort();
   }
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIStatus(3)

--- NEW FILE: CMCIClientFT.getProperty.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClientFT.getProperty() \- Get a named property value of an instance
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIData
.BI CMCIClientFT.getProperty (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				const char* name,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Get the named property value of an instance identified by reference \fIop\fP.
.PP
Arguments are the client object pointer \fIcl\fP, an ObjectPath object 
pointer \fIop\fP with the namespace and classname to identify the instance,
a pointer to a string with the property name to get in \fIname\fP,
and \fIrc\fP which returns the operation status (suppressed when NULL).
.PP
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.getProperty()\fP function returns
a CMPIData object with the instance property value and sets a successful
operation status code in \fIrc\fR.
When unsuccessful it returns the CMPIStatus object with sets an operation
status error code and corresponding error string.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
.sp
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIData(3), CMPIObjectPath(3), CMPIStatus(3)

--- NEW FILE: CMPIEnumeration.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMPIEnumeration \- CMPIEnumeration class implementation
.SH SYNOPSIS
.br
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "int \fBvoid * hdl\fP
.br
Opaque pointer to class instance data.
.ti -1c
.RI "\fBCMPIEnumerationFT\fP * \fBft\fP"
.br
.RI "\fIPointer to the Args Function Table. \fP"
.in -1c
.SH METHODS
.ti -1c
.RI "\fBCMPIStatus\fP(* \fBrelease\fP )(\fBCMPIEnumeration\fP *en)"
.br
.RI "\fIThe Enumeration object will not be used any further and may be freed by CMPI run time system. \fP"
.ti -1c
.RI "\fBCMPIEnumeration\fP *(* \fBclone\fP )(\fBCMPIEnumeration\fP *en, \fBCMPIStatus\fP *rc)"
.br
.RI "\fICreate an independent copy of this Enumeration object. \fP"
.ti -1c
.RI "\fBCMPIData\fP(* \fBgetNext\fP )(\fBCMPIEnumeration\fP *en, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGet the next element of this Enumeration. \fP"
.ti -1c
.RI "\fBCMPIBoolean\fP(* \fBhasNext\fP )(\fBCMPIEnumeration\fP *en, \fBCMPIStatus\fP *rc)"
.br
.RI "\fITest for any elements left in this Enumeration. \fP"
.ti -1c
.RI "\fBCMPIArray\fP *(* \fBtoArray\fP )(\fBCMPIEnumeration\fP *en, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIConvert this Enumeration into an Array. \fP"
.in -1c
.SH DESCRIPTION
.PP 
Native CMPIEnumeration implementation. 

This is the native CMPIEnumeration implementation as used for remote providers. It reflects the well-defined interface of a regular CMPIEnumeration, however, it works independently from the management broker.
.PP
It is part of a native broker implementation that simulates CMPI data types rather than interacting with the entities in a full-grown CIMOM.
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup

--- NEW FILE: CMCIClientFT.deleteInstance.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClientFT.deleteInstance() \- Delete class instance
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIStatus
.BI CMCIClientFT.deleteInstance (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op);
.br
.sp
.fi
.SH DESCRIPTION
Delete a class instance using \fIop\fP as the instance reference. 
.PP
Arguments are the client object pointer \fIcl\fP and an ObjectPath object 
pointer \fIop\fP that contains namespace and classname components.
.PP
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.deleteInstance()\fP function returns a
CMPIStatus object with a successful operation status code.
When unsuccessful it returns the operation error code and 
corresponding error string in the CMPIStatus object.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
.sp
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIStatus(3), CMPIObjectPath(3)

--- NEW FILE: CMCIClientFT.getClass.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClientFT.getClass() \- Get class as reference
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIConstClass *
.BI CMCIClientFT.getClass (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				CMPIFlags flags,
.br
.BI				char** properties,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Get Class using \fIop\fP as reference. The content of the returned
class structure can be controled using the \fIflags\fP parameter.
.PP
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 structure content, \fIproperties\fP
array, where if not NULL the members of the array define one or more Property
names, and \fIrc\fP the CMPI return status (suppressed when NULL).
.PP
The \fIflags\fP argument is a bit mask that can contain combinations of 
the following flags - CMPI_FLAG_LocalOnly, CMPI_FLAG_IncludeQualifiers and CMPI_FLAG_IncludeClassOrigin.
.PP
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 
returned.
If it's NULL all class properties are returned.
.PP
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.getClass()\fP function returns a pointer
to a CMPIConstClass object and sets a successful status code in \fIrc\fR.
When unsuccessful it returns NULL and sets the \fIrc\fP argument with the
error code and and corresponding error string.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
   CMCIClient *cc;
   CMPIObjectPath * objectpath;
   CMPIInstance * instance;
   CMPIEnumeration * enumeration;
   CMPIClass *class;
   CMPIStatus status;

   /* Setup a conncetion to the CIMOM */   
   cc = cmciConnect("localhost",NULL,NULL,NULL,NULL);

   objectpath = newCMPIObjectPath("root/cimv2", "Linux_ComputerSystem", NULL);
   class = cc->ft->getClass(cc, objectpath, 0, NULL, &status);

   if (!status.rc) {
	fprintf(stderr, "operation error code %d description %s\n",
			status.rc, status.msg->hdl);
	abort();
   }
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIConstClass(3), CMPIObjectPath(3), CMPIFlags(3), 
CMPIStatus(3)

--- NEW FILE: CMCIClientFT.createInstance.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClientFT.createInstance() \- Create class instance
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIObjectPath *
.BI CMCIClientFT.createInstance (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				CMPIInstance* inst,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Create class instance using \fIop\fP as reference.
.PP
Arguments are the client object pointer \fIcl\fP, ObjectPath object 
pointer \fIop\fP that contains namespace and classname components,
\fIinst\fP is a complete instance object pointer, and \fIrc\fP the
CMPI operation  status (suppressed when NULL).
.PP
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.createInstance()\fP function returns
a pointer to a CMPIObjectPath object with the new instance reference 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.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIObjectPath(3), CMPIInstance(3), CMPIStatus(3)

--- NEW FILE: CMPIInstance.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMPIInstance \- CMPIInstance class implementation
.SH SYNOPSIS
.br
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "int \fBvoid * hdl\fP
.br
Opaque pointer to class instance data.
.ti -1c
.RI "\fBCMPIInstanceFT\fP * \fBft\fP"
.br
.RI "\fIPointer to the Args Function Table. \fP"
.in -1c
.SH METHODS
.ti -1c
.RI "\fBCMPIStatus\fP(* \fBrelease\fP )(\fBCMPIInstance\fP *inst)"
.br
.RI "\fIThe Instance object will not be used any further and may be freed by CMPI run time system. \fP"
.ti -1c
.RI "\fBCMPIInstance\fP *(* \fBclone\fP )(\fBCMPIInstance\fP *inst, \fBCMPIStatus\fP *rc)"
.br
.RI "\fICreate an independent copy of this Instance object. \fP"
.ti -1c
.RI "\fBCMPIData\fP(* \fBgetProperty\fP )(\fBCMPIInstance\fP *inst, const char *name, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGets a named property value. \fP"
.ti -1c
.RI "\fBCMPIData\fP(* \fBgetPropertyAt\fP )(\fBCMPIInstance\fP *inst, unsigned int index, \fBCMPIString\fP **name, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGets a Property value defined by its index. \fP"
.ti -1c
.RI "unsigned int(* \fBgetPropertyCount\fP )(\fBCMPIInstance\fP *inst, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGets the number of properties contained in this Instance. \fP"
.ti -1c
.RI "\fBCMPIStatus\fP(* \fBsetProperty\fP )(\fBCMPIInstance\fP *inst, const char *name, \fBCMPIValue\fP *value, \fBCMPIType\fP type)"
.br
.RI "\fIAdds/replaces a named Property. \fP"
.ti -1c
.RI "\fBCMPIObjectPath\fP *(* \fBgetObjectPath\fP )(\fBCMPIInstance\fP *inst, \fBCMPIStatus\fP *rc)"
.br
.RI "\fIGenerates an ObjectPath out of the namespace, classname and key propeties of this Instance. \fP"
.ti -1c
.RI "\fBCMPIStatus\fP(* \fBsetPropertyFilter\fP )(\fBCMPIInstance\fP *inst, char **propertyList, char **keys)"
.br
.RI "\fIDirects CMPI to ignore any setProperty operations for this instance for any properties not in this list. \fP"
.in -1c
.SH DESCRIPTION
.PP 
Native CMPIInstance implementation. 

This is the native CMPIInstance implementation as used for remote providers. It reflects the well-defined interface of a regular CMPIInstance, however, it works independently from the management broker.
.PP
It is part of a native broker implementation that simulates CMPI data types rather than interacting with the entities in a full-grown CIMOM.
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup

--- NEW FILE: CMCIClientFT.referenceNames.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClientFT.referenceNames() \- Enumerate association ObjectPaths for a class instance
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIEnumeration *
.BI CMCIClientFT.referenceNames (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				const char *resultClass,
.br
.BI				const char *role,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Enumerate association instances that refer to the Instance defined
by the \fIop\fP reference.
.PP
Arguments are the client object pointer \fIcl\fP, an ObjectPath object 
pointer \fIop\fP with the reference that contains namespace and classname
components,
\fIresultClass\fP, where if it's not NULL is a valid class name that 
is used to filter the returned set of association objects by eliminating
objects that aren't an Instance of this Class or one of its subclasses,
\fIrole\fP, where if it's not NULL is a valid property name that 
is used to filter the returned set of instance objects by eliminating
objects that aren't associated to the source object by an association 
where the source object plays the specified role, i.e. the name of the 
property in the association class that refers to the source object 
has to match the value of this parameter,
and \fIrc\fP which returns the operation status (suppressed when NULL).
.PP
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.referenceNames()\fP function returns
a pointer to a CMPIEnumeration object that contains the class association
reference objects found that match the association criteria, and sets a 
successful operation status code in \fIrc\fR.
When unsuccessful it returns a NULL pointer and sets the operation 
status error code and corresponding error string in \fIrc\fP.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
.sp
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIStatus(3)

--- NEW FILE: CMCIClientFT.getInstance.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClientFT.getInstance() \- Get class instance
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIInstance *
.BI CMCIClientFT.getInstance (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				CMPIFlags flags,
.br
.BI				char** properties,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Get class instance using \fIop\fP as reference. The content of the returned
class instance structure can be controled using the \fIflags\fP parameter.
.PP
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).
.PP
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.
.PP
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 
returned.
If it's NULL all class properties are returned.
.PP
.SH "RETURN VALUE"
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.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
.sp
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIInstance(3), CMPIObjectPath(3), CMPIFlags(3), 
CMPIStatus(3)

--- NEW FILE: CMCIClientFT.invokeMethod.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClientFT.invokeMethod() \- Invoke a named method of an instance
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIEnumeration *
.BI CMCIClientFT.invokeMethod (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				const char* method,
.br
.BI				CMPIArgs* in,
.br
.BI				CMPIArgs* out,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Invoke a named method of an instance defined by the \fIop\fP reference.
.PP
Arguments are the client object pointer \fIcl\fP, an ObjectPath object 
pointer \fIop\fP with the reference that contains namespace and classname
components,
\fImethod\fP pointer to string that identifies the class method,
\fIin\fP pointer to the input arguments,
\fIout\fP pointer to the output parameters,
and \fIrc\fP which returns the operation status (suppressed when NULL).
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.invokeMethod()\fP function returns
the CMPIData value returned by the method invoked and sets a successful
operation status code in \fIrc\fR.
When unsuccessful it returns a NULL pointer and sets the operation 
status error code and corresponding error string in \fIrc\fP.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
.sp
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIArgs(3),
CMPIStatus(3)

--- NEW FILE: CMCIClientFT.enumClassNames.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCICLientFT.enumClassNames() \- Enumerate class names
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIEnumeration *
.BI CMCIClientFT.enumClassNames (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				CMPIFlags flags,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Get Class using \fIop\fP as reference. The content of the returned
class structure can be controled using the \fIflags\fP parameter.
.PP
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 structure content, 
and \fIrc\fP the CMPI return status (suppressed when NULL).
.PP
The \fIflags\fP argument is a bit mask that can contain the flag 
\fICMPI_FLAG_DeepInheritance\fP.
.PP
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.enumClassNames()\fP function returns
a pointer to a CMPIEnumeration object that contains each class name found
and sets a successful status code in \fIrc\fR.
When unsuccessful it returns NULL and sets the \fIrc\fP argument with the
error code and and corresponding error string.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
.nf
   CMCIClient *cc;
   CMPIObjectPath * objectpath;
   CMPIEnumeration * enumeration;
   CMPIStatus status;

   /* Setup a conncetion to the CIMOM */   
   cc = cmciConnect("localhost",NULL,NULL,NULL,NULL);

   objectpath = newCMPIObjectPath("root/cimv2", NULL, NULL);
   enumeration = cc->ft->enumClassNames(cc, objectpath, 0, &status);

   if (!status.rc) {
	fprintf(stderr, "op error code %d description %s\n",
			 status.rc, status.msg->hdl);
	abort();
   }
.fi
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIFlags(3),
CMPIStatus(3)

--- NEW FILE: CMCIClientFT.enumInstances.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMCIClientFT.enumInstances() \- Enumerate instances of a class
.SH SYNOPSIS
.nf
.B #include <cmci.h>
.sp
.BI CMPIEnumeration *
.BI CMCIClientFT.enumInstances (CMCIClient* cl,
.br
.BI				CMPIObjectPath* op,
.br
.BI				CMPIFlags flags,
.br
.BI				char** properties,
.br
.BI				CMPIStatus* rc);
.br
.sp
.fi
.SH DESCRIPTION
Enumerate Instances of the class (and subclasses) defined by \fIop\fP.
The instance structure and inheritance scope can be controled using the
\fIflags\fP argument.
.PP
Arguments are the client object pointer \fIcl\fP, an ObjectPath object 
pointer \fIop\fP with the reference that contains namespace and classname
components,
\fIflags\fP that affect the content of the returned class instance structures,
a \fIproperties\fP array, and \fIrc\fP which returns the operation status 
(suppressed when NULL).
.PP
The \fIflags\fP argument is a bit mask that can contains the following 
flags - \fICMPI_FLAG_LocalOnly\fP, \fICMPI_FLAG_DeepInheritance\fP, 
\fICMPI_FLAG_IncludeQualifiers\fP and \fICMPI_FLAG_IncludeClassOrigin\fP.
.SH "RETURN VALUE"
When successful the \fBCMCIClientFT.enumInstances()\fP function returns
a pointer to a CMPIEnumeration object that contains the class instances 
found for the class and sets a successful operation status code in \fIrc\fR.
When unsuccessful it returns a NULL pointer and sets the operation 
status error code and corresponding error string in \fIrc\fP.
.SH "ERRORS"
.sp
.SH "EXAMPLES"
   CMCIClient *cc;
   CMPIObjectPath * objectpath;
   CMPIInstance * instance;
   CMPIEnumeration * enumeration;
   CMPIStatus status;

   /* Setup a conncetion to the CIMOM */   
   cc = cmciConnect("localhost",NULL,NULL,NULL,NULL);

   objectpath = newCMPIObjectPath("root/cimv2", NULL, NULL);
   enumeration = cc->ft->enumInstances(cc, objectpath, 0, NULL, &status);

   if (!status.rc) {
	fprintf(stderr, "operation error code %d description %s\n",
			status.rc, status.msg->hdl);
	abort();
   }
.SH "CONFORMING TO"
.sp
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup,
.br
CMCIClient(3), CMPIEnumeration(3), CMPIObjectPath(3), CMPIFlags(3),
CMPIStatus(3)

--- NEW FILE: CMPIValue.3 ---
.TH  3  2005-06-09 "sfcc" "SFCBroker Client Library"
.SH NAME
CMPIValue \- CMPIValue class implementation
.SH SYNOPSIS
.br
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBCMPIUint64\fP \fBuint64\fP"
.br
.ti -1c
.RI "\fBCMPIUint32\fP \fBuint32\fP"
.br
.ti -1c
.RI "\fBCMPIUint16\fP \fBuint16\fP"
.br
.ti -1c
.RI "\fBCMPIUint8\fP \fBuint8\fP"
.br
.ti -1c
.RI "\fBCMPISint64\fP \fBsint64\fP"
.br
.ti -1c
.RI "\fBCMPISint32\fP \fBsint32\fP"
.br
.ti -1c
.RI "\fBCMPISint16\fP \fBsint16\fP"
.br
.ti -1c
.RI "\fBCMPISint8\fP \fBsint8\fP"
.br
.ti -1c
.RI "\fBCMPIReal64\fP \fBreal64\fP"
.br
.ti -1c
.RI "\fBCMPIReal32\fP \fBreal32\fP"
.br
.ti -1c
.RI "\fBCMPIBoolean\fP \fBboolean\fP"
.br
.ti -1c
.RI "\fBCMPIChar16\fP \fBchar16\fP"
.br
.ti -1c
.RI "\fBCMPIInstance\fP * \fBinst\fP"
.br
.ti -1c
.RI "\fBCMPIObjectPath\fP * \fBref\fP"
.br
.ti -1c
.RI "\fBCMPIArgs\fP * \fBargs\fP"
.br
.ti -1c
.RI "\fBCMPIEnumeration\fP * \fBEnum\fP"
.br
.ti -1c
.RI "\fBCMPIArray\fP * \fBarray\fP"
.br
.ti -1c
.RI "\fBCMPIString\fP * \fBstring\fP"
.br
.ti -1c
.RI "char * \fBchars\fP"
.br
.ti -1c
.RI "\fBCMPIDateTime\fP * \fBdateTime\fP"
.br
.ti -1c
.RI "\fBCMPIValuePtr\fP \fBdataPtr\fP"
.br
.ti -1c
.RI "\fBCMPISint8\fP \fBByte\fP"
.br
.ti -1c
.RI "\fBCMPISint16\fP \fBShort\fP"
.br
.ti -1c
.RI "\fBCMPISint32\fP \fBInt\fP"
.br
.ti -1c
.RI "\fBCMPISint64\fP \fBLong\fP"
.br
.ti -1c
.RI "\fBCMPIReal32\fP \fBFloat\fP"
.br
.ti -1c
.RI "\fBCMPIReal64\fP \fBDouble\fP"
.br
.in -1c
.SH METHODS

.in +1c
.ti -1c
.RI "void \fBnative_release_CMPIValue\fP (\fBCMPIType\fP type, \fBCMPIValue\fP *val)"
.br
.ti -1c
.RI "\fBCMPIValue\fP \fBnative_clone_CMPIValue\fP (\fBCMPIType\fP type, \fBCMPIValue\fP *val, \fBCMPIStatus\fP *rc)"
.br
.ti -1c
.RI "char * \fBpathToChars\fP (\fBCMPIObjectPath\fP *cop, \fBCMPIStatus\fP *rc, char *str, int uri)"
.br
.ti -1c
.RI "char * \fBvalue2CharsUri\fP (\fBCMPIType\fP type, \fBCMPIValue\fP *value, int uri)"
.br
.ti -1c
.RI "char * \fBvalue2Chars\fP (\fBCMPIType\fP type, \fBCMPIValue\fP *value)"
.br
.ti -1c
.RI "char * \fBkeytype2Chars\fP (\fBCMPIType\fP type)"
.br
.ti -1c
.RI "\fBCMPIValue\fP * \fBgetKeyValueTypePtr\fP (char *type, char *value, \fBXtokValueReference\fP *ref, \fBCMPIValue\fP *val, \fBCMPIType\fP *typ)"
.br
.ti -1c
.RI "\fBCMPIType\fP \fBguessType\fP (char *val)"
.br
.ti -1c
.RI "\fBCMPIValue\fP \fBstr2CMPIValue\fP (\fBCMPIType\fP type, char *val, \fBXtokValueReference\fP *ref)"
.br
.in -1c
.SH DESCRIPTION
.PP 
CMPIValue class implementation, representing the Encapsulated value objects. 

This is the native CMPIValue implementation as used for remote providers. It reflects the well-defined interface of a regular CMPIValue, however, it works independently from the management broker.
.PP
It is part of a native broker implementation that simulates CMPI data types rather than interacting with the entities in a full-grown CIMOM.
.SH "SEE ALSO"
Common Manageability Programming Interface (CMPI) - OpenGroup