cmpimacs.h File Reference

Defines CMPI convenience functions that ease the use of the various function tables. More...

#include <cmpift.h>

Go to the source code of this file.

Macros
#define	CMReturn(rc)
	Return the calling function with CMPIStatus specifying a return code and no message. More...
#define	CMReturnWithString(rc, str)
	Return the calling function with CMPIStatus specifying a return code and a message (from CMPIString object). More...
#define	CMReturnWithChars(mb, rc, chars)
	Return the calling function with CMPIStatus specifying a return code and a message (from C string). More...
#define	CMRelease(obj)
	Release an encapsulated data type object. More...
#define	CMClone(obj, rc)
	Clone an encapsulated data type object. More...
#define	CMGetMessage(mb, msgId, defMsg, rc, args)
	Get a translated MB implementation-specific message text by message ID. (Deprecated) More...
#define	CMGetMessage2(mb, msgId, msgFileHandle, defMsg, rc, args)
	Get a translated message text from an open message file by message ID. More...
#define	CMFmtArgs0()   0
	Args value for no message insert pairs.
#define	CMFmtArgs1(v1)   1,v1
	Args value for 1 message insert pair.
#define	CMFmtArgs2(v1, v2)   2,v1,v2
	Args value for 2 message insert pairs.
#define	CMFmtArgs3(v1, v2, v3)   3,v1,v2,v3
	Args value for 3 message insert pairs.
#define	CMFmtArgs4(v1, v2, v3, v4)   4,v1,v2,v3,v4
	Args value for 4 message insert pairs.
#define	CMFmtArgs5(v1, v2, v3, v4, v5)   5,v1,v2,v3,v4,v5
	Args value for 5 message insert pairs.
#define	CMFmtArgs6(v1, v2, v3, v4, v5, v6)   6,v1,v2,v3,v4,v5,v6
	Args value for 6 message insert pairs.
#define	CMFmtArgs7(v1, v2, v3, v4, v5, v6, v7)   7,v1,v2,v3,v4,v5,v6,v7
	Args value for 7 message insert pairs.
#define	CMFmtArgs8(v1, v2, v3, v4, v5, v6, v7, v8)   8,v1,v2,v3,v4,v5,v6,v7,v8
	Args value for 8 message insert pairs.
#define	CMFmtArgs9(v1, v2, v3, v4, v5, v6, v7, v8, v9)   9,v1,v2,v3,v4,v5,v6,v7,v8,v9
	Args value for 9 message insert pairs.
#define	CMFmtArgs10(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10)   10,v1,v2,v3,v4,v5,v6,v7,v8,v9,v10
	Args value for 10 message insert pairs.
#define	CMFmtSint(v)   CMPI_sint32,((long int)v)
	Message insert pair for a signed integer value up to 32-bit.
#define	CMFmtUint(v)   CMPI_uint32,((unsigned long int)v)
	Message insert pair for an unsigned integer value up to 32-bit.
#define	CMFmtSint64(v)   CMPI_sint64,((long long int)v)
	Message insert pair for a signed integer value up to 64-bit.
#define	CMFmtUint64(v)   CMPI_uint64,((unsigned long long int)v)
	Message insert pair for an unsigned integer value up to 64-bit.
#define	CMFmtReal(v)   CMPI_real64,((double)v)
	Message insert pair for a CIM real64 value.
#define	CMFmtBoolean(v)   CMPI_boolean,((int)v)
	Message insert pair for a boolean value.
#define	CMFmtChars(v)   CMPI_chars,((char*)v)
	Message insert pair for a C string value.
#define	CMFmtString(v)   CMPI_string,((CMPIString*)v)
	Message insert pair for a CMPIString value.
#define	CMInstanceMIStub(pfx, miname, mbvar, hook)
	Generate function table and factory function for an instance MI written in plain C. More...
#define	CMAssociationMIStub(pfx, miname, mbvar, hook)
	Generate function table and factory function for an association MI written in plain C. More...
#define	CMMethodMIStub(pfx, miname, mbvar, hook)
	Generate function table and factory function for a method MI written in plain C. More...
#define	CMPropertyMIStub(pfx, miname, mbvar, hook)
	Generate function table and factory function for a property MI written in plain C (Deprecated). More...
#define	CMIndicationMIStub(pfx, miname, mbvar, hook)
	Generate function table and factory function for an indication MI written in plain C. More...
#define	CMInitHook(pfx, mitype)
	MI factory stub hook statement specifying additional initialization. More...
#define	CMNoHook
	MI factory stub hook statement specifying no additional initialization. More...
#define	CMInstanceMIFactory(cn, miname)
	Generate function table and factory function for an instance MI written in C++. More...
#define	CMAssociationMIFactory(cn, miname)
	Generate function table and factory function for an association MI written in C++. More...
#define	CMMethodMIFactory(cn, miname)
	Generate function table and factory function for a method MI written in C++. More...
#define	CMPropertyMIFactory(cn, miname)
	Generate function table and factory function for a property MI written in C++ (Deprecated). More...
#define	CMIndicationMIFactory(cn, miname)
	Generate function table and factory function for an indication MI written in C++. More...
#define	CMProviderBase(miname)
	CMProviderBase macro. More...

Functions
static void	CMSetStatus (CMPIStatus *st, CMPIrc rc)
	Initialize a CMPIStatus structure with a return code and no message. More...
static void	CMSetStatusWithString (CMPIStatus *st, CMPIrc rc, CMPIString *msg)
	Initializes a CMPIStatus object with CMPIStatus and message. More...
static void	CMSetStatusWithChars (const CMPIBroker *mb, CMPIStatus *st, CMPIrc rc, const char *msg)
	Initializes CMPIStatus struct with return code and message text message. More...
static CMPIBoolean	CMIsNullObject (const void *objptr)
	Test an encapsulated data type object pointer for NULL. More...
static CMPIBoolean	CMIsNullValue (CMPIData data)
	Test a CMPIData value for NULL. More...
static CMPIBoolean	CMIsKeyValue (CMPIData data)
	Test a CMPIData value for being a key. More...
static CMPIBoolean	CMIsArray (CMPIData data)
	Test a CMPIData value for having an array type. More...
static CMPIData	CMGetContextEntry (const CMPIContext *ctx, const char *name, CMPIStatus *rc)
	Get a context entry in a CMPIContext object by name. More...
static CMPIData	CMGetContextEntryAt (const CMPIContext *ctx, CMPICount index, CMPIString **name, CMPIStatus *rc)
	Get a context entry in a CMPIContext object by index. More...
static CMPICount	CMGetContextEntryCount (const CMPIContext *ctx, CMPIStatus *rc)
	Get the number of context entries in a CMPIContext object. More...
static CMPIStatus	CMAddContextEntry (const CMPIContext *ctx, const char *name, const CMPIValue *value, const CMPIType type)
	Add or replace a context entry in a CMPIContext object. More...
static CMPIStatus	CMReturnData (const CMPIResult *rslt, const CMPIValue *value, const CMPIType type)
	Add a value/type pair to a CMPIResult object. More...
static CMPIStatus	CMReturnInstance (const CMPIResult *rslt, const CMPIInstance *inst)
	Add an instance to a CMPIResult object. More...
static CMPIStatus	CMReturnObjectPath (const CMPIResult *rslt, const CMPIObjectPath *op)
	Add an object path to a CMPIResult object. More...
static CMPIStatus	CMReturnDone (const CMPIResult *rslt)
	Indicate that no further items will be added to a CMPIResult object. More...
static CMPIStatus	CMReturnError (const CMPIResult *rslt, const CMPIError *er)
	Add an error to a CMPIResult object. More...
static const char *	CMGetCharPtr (const CMPIString *str)
	Get the C-language string representation of a CMPIString object (Deprecated). More...
static const char *	CMGetCharsPtr (const CMPIString *str, CMPIStatus *rc)
	Get a C-language string representation of a CMPIString object. More...
static char *	CMNewCharsCP (const CMPIString *str, const CMPICodepageID cpid, CMPIStatus *rc)
	Create a C-language string that has converted a CMPIString object into a specific codepage. More...
static CMPICount	CMGetArrayCount (const CMPIArray *ar, CMPIStatus *rc)
	Get the number of array elements in a CMPIArray object. More...
static CMPIType	CMGetArrayType (const CMPIArray *ar, CMPIStatus *rc)
	Get the type of the array elements in a CMPIArray object. More...
static CMPIData	CMGetArrayElementAt (const CMPIArray *ar, CMPICount index, CMPIStatus *rc)
	Get an array element in a CMPIArray object by index. More...
static CMPIStatus	CMSetArrayElementAt (const CMPIArray *ar, CMPICount index, const CMPIValue *value, CMPIType type)
	Set the value of an existing array element in a CMPIArray object by index. More...
static CMPIData	CMGetNext (const CMPIEnumeration *en, CMPIStatus *rc)
	Get the next element in a CMPIEnumeration object. More...
static CMPIBoolean	CMHasNext (const CMPIEnumeration *en, CMPIStatus *rc)
	Test for any elements left in a CMPIEnumeration object. More...
static CMPIArray *	CMToArray (const CMPIEnumeration *en, CMPIStatus *rc)
	Convert a CMPIEnumeration object to a CMPIArray object. More...
static CMPIData	CMGetProperty (const CMPIInstance *inst, const char *name, CMPIStatus *rc)
	Get a property in a CMPIInstance object by name. More...
static CMPIData	CMGetPropertyAt (const CMPIInstance *inst, CMPICount index, CMPIString **name, CMPIStatus *rc)
	Get a property in a CMPIInstance object by index. More...
static CMPICount	CMGetPropertyCount (const CMPIInstance *inst, CMPIStatus *rc)
	Get the number of properties in a CMPIInstance object. More...
static CMPIStatus	CMSetProperty (const CMPIInstance *inst, const char *name, const CMPIValue *value, const CMPIType type)
	Add or replace a property value in a CMPIInstance object by name. More...
static CMPIObjectPath *	CMGetObjectPath (const CMPIInstance *inst, CMPIStatus *rc)
	Get the instance path component of a CMPIInstance object. More...
static CMPIStatus	CMSetPropertyFilter (const CMPIInstance *inst, const char **properties, const char **keyList)
	Attach a property filter to a CMPIInstance object. More...
static CMPIStatus	CMSetObjectPath (const CMPIInstance *inst, const CMPIObjectPath *op)
	Set the instance path component of a CMPIInstance object. More...
static CMPIStatus	CMSetPropertyWithOrigin (const CMPIInstance *inst, const char *name, const CMPIValue *value, CMPIType type, const char *origin)
	Add or replace a property value and class origin in a CMPIInstance object by name. More...
static CMPIStatus	CMSetNameSpace (const CMPIObjectPath *op, const char *ns)
	Set the namespace component in a CMPIObjectPath object. More...
static CMPIString *	CMGetNameSpace (const CMPIObjectPath *op, CMPIStatus *rc)
	Get the namespace component from a CMPIObjectPath object. More...
static CMPIStatus	CMSetHostname (const CMPIObjectPath *op, const char *hn)
	Set the host name component in a CMPIObjectPath object. More...
static CMPIString *	CMGetHostname (const CMPIObjectPath *op, CMPIStatus *rc)
	Get the host name component in a CMPIObjectPath object. More...
static CMPIStatus	CMSetClassName (const CMPIObjectPath *op, const char *cn)
	Set class name component in a CMPIObjectPath object. More...
static CMPIString *	CMGetClassName (const CMPIObjectPath *op, CMPIStatus *rc)
	Get the class name component from CMPIObjectPath. More...
static CMPIStatus	CMAddKey (const CMPIObjectPath *op, const char *key, const CMPIValue *value, const CMPIType type)
	Add or replace a key binding in a CMPIObjectPath object. More...
static CMPIData	CMGetKey (const CMPIObjectPath *op, const char *key, CMPIStatus *rc)
	Get a key binding in a CMPIObjectPath object by name. More...
static CMPIData	CMGetKeyAt (const CMPIObjectPath *op, CMPICount index, CMPIString **name, CMPIStatus *rc)
	Get a key binding in a CMPIObjectPath object by index. More...
static CMPICount	CMGetKeyCount (const CMPIObjectPath *op, CMPIStatus *rc)
	Get the number of key bindings in a CMPIObjectPath object. More...
static CMPIStatus	CMSetNameSpaceFromObjectPath (const CMPIObjectPath *op, const CMPIObjectPath *src)
	Set the namespace and class name components in a CMPIObjectPath object from another CMPIObjectPath object. More...
static CMPIStatus	CMSetHostAndNameSpaceFromObjectPath (const CMPIObjectPath *op, const CMPIObjectPath *src)
	Set host name, namespace, and class name components in a CMPIObjectPath object from another CMPIObjectPath object. More...
static CMPIData	CMGetClassQualifier (const CMPIObjectPath *op, const char *qName, CMPIStatus *rc)
	Get a class qualifier. More...
static CMPIData	CMGetPropertyQualifier (const CMPIObjectPath *op, const char *pName, const char *qName, CMPIStatus *rc)
	Get a property qualifier. More...
static CMPIData	CMGetMethodQualifier (const CMPIObjectPath *op, const char *mName, const char *qName, CMPIStatus *rc)
	Get a method qualifier. More...
static CMPIData	CMGetParameterQualifier (const CMPIObjectPath *op, const char *mName, const char *pName, const char *qName, CMPIStatus *rc)
	Get a parameter qualifier. More...
static CMPIStatus	CMAddArg (const CMPIArgs *args, const char *name, const CMPIValue *value, const CMPIType type)
	Add or replace a method parameter in a CMPIArgs object. More...
static CMPIData	CMGetArg (const CMPIArgs *args, const char *name, CMPIStatus *rc)
	Get a method parameter in a CMPIArgs object by name. More...
static CMPIData	CMGetArgAt (const CMPIArgs *args, CMPICount index, CMPIString **name, CMPIStatus *rc)
	Get a method parameter in a CMPIArgs object by index. More...
static CMPICount	CMGetArgCount (const CMPIArgs *args, CMPIStatus *rc)
	Get the number of method parameters in a CMPIArgs object. More...
static CMPIUint64	CMGetBinaryFormat (const CMPIDateTime *dt, CMPIStatus *rc)
	Get the value of a CMPIDateTime object in binary format. More...
static CMPIString *	CMGetStringFormat (const CMPIDateTime *dt, CMPIStatus *rc)
	Get the value of a CMPIDateTime object in the string format defined for the CIM datetime type. More...
static CMPIBoolean	CMIsInterval (const CMPIDateTime *dt, CMPIStatus *rc)
	Test whether a CMPIDateTime object contains an interval value. More...
static CMPIBoolean	CMEvaluateSelExp (const CMPISelectExp *se, const CMPIInstance *inst, CMPIStatus *rc)
	Test whether an instance matches the select expression in a CMPISelectExp object. More...
static CMPIString *	CMGetSelExpString (const CMPISelectExp *se, CMPIStatus *rc)
	Get the select expression in a CMPISelectExp object as a string. More...
static CMPISelectCond *	CMGetDoc (const CMPISelectExp *se, CMPIStatus *rc)
	Get the select expression in a CMPISelectExp object as a disjunction of conjunctions. More...
static CMPISelectCond *	CMGetCod (const CMPISelectExp *se, CMPIStatus *rc)
	Get the select expression in a CMPISelectExp object as a conjunction of disjunctions. More...
static CMPIBoolean	CMEvaluateSelExpUsingAccessor (const CMPISelectExp *se, const CMPIAccessor *accessor, void *parm, CMPIStatus *rc)
	Test whether the properties returned by an accessor function match the select expression in a CMPISelectExp object. More...
static CMPICount	CMGetSubCondCountAndType (const CMPISelectCond *sc, int *type, CMPIStatus *rc)
	Get the number and type of subconditions in a CMPISelectCond object. More...
static CMPISubCond *	CMGetSubCondAt (const CMPISelectCond *sc, CMPICount index, CMPIStatus *rc)
	Get a subcondition in a CMPISelectCond object by index. More...
static CMPICount	CMGetPredicateCount (const CMPISubCond *sc, CMPIStatus *rc)
	Get the number of predicates in a CMPISubCond object. More...
static CMPIPredicate *	CMGetPredicateAt (const CMPISubCond *sc, CMPICount index, CMPIStatus *rc)
	Get a predicate in a CMPISubCond object by index. More...
static CMPIPredicate *	CMGetPredicate (const CMPISubCond *sc, const char *name, CMPIStatus *rc)
	Get a predicate in a CMPISubCond object by name. More...
static CMPIStatus	CMGetPredicateData (const CMPIPredicate *pr, CMPIType *type, CMPIPredOp *prop, CMPIString **lhs, CMPIString **rhs)
	Get the predicate components of a CMPIPredicate object. More...
static CMPIBoolean	CMEvaluatePredicateUsingAccessor (const CMPIPredicate *pr, const CMPIAccessor *accessorFnc, void *parm, CMPIStatus *rc)
	Test whether the properties returned by an accessor function match the predicate in a CMPIPredicate object. More...
static CMPIErrorType	CMGetErrorType (const CMPIError *er, CMPIStatus *rc)
	Get the ErrorType attribute of a CMPIError object. More...
static CMPIString *	CMGetOtherErrorType (const CMPIError *er, CMPIStatus *rc)
	Get the OtherErrorType attribute of a CMPIError object. More...
static CMPIString *	CMGetOwningEntity (const CMPIError *er, CMPIStatus *rc)
	Get the OwningEntity attribute of a CMPIError object. More...
static CMPIString *	CMGetMessageID (const CMPIError *er, CMPIStatus *rc)
	Get the MessageID attribute of a CMPIError object. More...
static CMPIString *	CMGetErrorMessage (const CMPIError *er, CMPIStatus *rc)
	Get the Message attribute of a CMPIError object. More...
static CMPIErrorSeverity	CMGetPerceivedSeverity (const CMPIError *er, CMPIStatus *rc)
	Get the PerceivedSeverity attribute of a CMPIError object. More...
static CMPIErrorProbableCause	CMGetProbableCause (const CMPIError *er, CMPIStatus *rc)
	Get the ProbableCause attribute of a CMPIError object. More...
static CMPIString *	CMGetProbableCauseDescription (const CMPIError *er, CMPIStatus *rc)
	Get the ProbableCauseDescription attribute of a CMPIError object. More...
static CMPIArray *	CMGetRecommendedActions (const CMPIError *er, CMPIStatus *rc)
	Get the RecommendedActions array attribute of a CMPIError object. More...
static CMPIString *	CMGetErrorSource (const CMPIError *er, CMPIStatus *rc)
	Get the ErrorSource attribute of a CMPIError object. More...
static CMPIErrorSrcFormat	CMGetErrorSourceFormat (const CMPIError *er, CMPIStatus *rc)
	Get the ErrorSourceFormat attribute of a CMPIError object. More...
static CMPIString *	CMGetOtherErrorSourceFormat (const CMPIError *er, CMPIStatus *rc)
	Get the OtherErrorSourceFormat attribute of a CMPIError object. More...
static CMPIrc	CMGetCIMStatusCode (const CMPIError *er, CMPIStatus *rc)
	Get the CIMStatusCode attribute of a CMPIError object. More...
static CMPIString *	CMGetCIMStatusCodeDescription (const CMPIError *er, CMPIStatus *rc)
	Get the CIMStatusCodeDescription attribute of a CMPIError object. More...
static CMPIArray *	CMGetMessageArguments (const CMPIError *er, CMPIStatus *rc)
	Get the MessageArguments array attribute of a CMPIError object. More...
static CMPIStatus	CMSetErrorType (const CMPIError *er, const CMPIErrorType et)
	Set the ErrorType attribute of a CMPIError object. More...
static CMPIStatus	CMSetOtherErrorType (const CMPIError *er, const char *ot)
	Set the OtherErrorType attribute of a CMPIError object. More...
static CMPIStatus	CMSetProbableCauseDescription (const CMPIError *er, const char *pcd)
	Set the ProbableCauseDescription attribute of a CMPIError object. More...
static CMPIStatus	CMSetRecommendedActions (const CMPIError *er, const CMPIArray *ra)
	Set the RecommendedActions array attribute of a CMPIError object. More...
static CMPIStatus	CMSetErrorSource (const CMPIError *er, const char *es)
	Set the ErrorSource attribute of a CMPIError object. More...
static CMPIStatus	CMSetErrorSourceFormat (const CMPIError *er, const CMPIErrorSrcFormat esf)
	Set the ErrorSourceFormat attribute of a CMPIError object. More...
static CMPIStatus	CMSetOtherErrorSourceFormat (const CMPIError *er, const char *oef)
	Set the OtherErrorSourceFormat attribute of a CMPIError object. More...
static CMPIStatus	CMSetCIMStatusCodeDescription (const CMPIError *er, const char *scd)
	Set the CIMStatusCodeDescription attribute of a CMPIError object. More...
static CMPIStatus	CMSetMessageArguments (const CMPIError *er, const CMPIArray *values)
	Set the MessageArguments array attribute of a CMPIError object. More...
static CMPIBoolean	CMIsPropertyInList (const CMPIPropertyList *plist, const char *pname, CMPIStatus *rc)
	Test whether a property is in the property list represented by a CMPIPropertyList object. More...
static const char **	CMGetListProperties (const CMPIPropertyList *plist, CMPIStatus *rc)
	Return the property list represented by a CMPIPropertyList object as an array of C-language strings. More...
static CMPIBoolean	CMFilterMatch (const CMPIEnumerationFilter *ef, const CMPIInstance *inst, CMPIStatus *rc)
	Test whether an instance matches the filter represented by a CMPIEnumerationFilter object. More...
static unsigned int	CBGetCapabilities (const CMPIBroker *mb)
	Get the MB capabilities. More...
static CMPIVersion	CBBrokerVersion (const CMPIBroker *mb)
	Get the CMPI version supported by the MB. More...
static const char *	CBBrokerName (const CMPIBroker *mb)
	Get the MB name. More...
static CMPIContext *	CBPrepareAttachThread (const CMPIBroker *mb, const CMPIContext *ctx)
	Prepare the MB to accept a new thread that will be using MB functions. More...
static CMPIStatus	CBAttachThread (const CMPIBroker *mb, const CMPIContext *ctx)
	Inform the MB that the current thread will begin using MB functions. More...
static CMPIStatus	CBDetachThread (const CMPIBroker *mb, const CMPIContext *ctx)
	Inform the MB that the current thread will no longer use MB functions. More...
static CMPIStatus	CBDeliverIndication (const CMPIBroker *mb, const CMPIContext *ctx, const char *ns, const CMPIInstance *ind)
	Request delivery of an indication. More...
static CMPIEnumeration *	CBEnumInstanceNames (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *classPath, CMPIStatus *rc)
	Enumerate the instance paths of the instances of a given class (and its subclasses). More...
static CMPIEnumeration *	CBEnumInstances (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *classPath, const char **properties, CMPIStatus *rc)
	Enumerate the instances of a given class (and its subclasses). More...
static CMPIInstance *	CBGetInstance (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *instPath, const char **properties, CMPIStatus *rc)
	Get an existing instance. More...
static CMPIObjectPath *	CBCreateInstance (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *classPath, const CMPIInstance *newInst, CMPIStatus *rc)
	Create an instance of a given class. More...
static CMPIStatus	CBModifyInstance (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *instPath, const CMPIInstance *modInst, const char **properties)
	Modify property values of an existing instance. More...
static CMPIStatus	CBDeleteInstance (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *instPath)
	Delete an existing instance. More...
static CMPIEnumeration *	CBExecQuery (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *classPath, const char *query, const char *lang, CMPIStatus *rc)
	Execute a query on a given class and return the query result. More...
static CMPIEnumeration *	CBAssociators (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *instPath, const char *assocClass, const char *resultClass, const char *role, const char *resultRole, const char **properties, CMPIStatus *rc)
	Enumerate the instances associated with a given source instance. More...
static CMPIEnumeration *	CBAssociatorNames (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *instPath, const char *assocClass, const char *resultClass, const char *role, const char *resultRole, CMPIStatus *rc)
	Enumerate the instance paths of the instances associated with a given source instance. More...
static CMPIEnumeration *	CBReferences (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *instPath, const char *resultClass, const char *role, const char **properties, CMPIStatus *rc)
	Enumerate the association instances referencing a given source instance. More...
static CMPIEnumeration *	CBReferenceNames (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *instPath, const char *resultClass, const char *role, CMPIStatus *rc)
	Enumerate the instance paths of the association instances referencing a given source instance. More...
static CMPIData	CBInvokeMethod (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *objPath, const char *method, const CMPIArgs *in, CMPIArgs *out, CMPIStatus *rc)
	Invoke a method on a target object. More...
static CMPIStatus	CBSetProperty (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *instPath, const char *name, const CMPIValue *value, const CMPIType type)
	Set or modify a property of an existing instance. (Deprecated) More...
static CMPIData	CBGetProperty (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *instPath, const char *name, CMPIStatus *rc)
	Get a property of an existing instance. (Deprecated) More...
static CMPIEnumeration *	CBEnumInstancesFiltered (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *classPath, const char **properties, const char *filterQueryLanguage, const char *filterQuery, CMPIStatus *rc)
	Enumerate the instances of a given class (and its subclasses), returning only those that match the given query filter. More...
static CMPIEnumeration *	CBAssociatorsFiltered (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *instPath, const char *assocClass, const char *resultClass, const char *role, const char *resultRole, const char **properties, const char *filterQueryLanguage, const char *filterQuery, CMPIStatus *rc)
	Enumerate the instances associated with a given source instance, returning only those that match the given filters. More...
static CMPIEnumeration *	CBReferencesFiltered (const CMPIBroker *mb, const CMPIContext *ctx, const CMPIObjectPath *instPath, const char *resultClass, const char *role, const char **properties, const char *filterQueryLanguage, const char *filterQuery, CMPIStatus *rc)
	Enumerate the instances referencing a given source instance, returning only those that match the given filters. More...
static CMPIInstance *	CMNewInstance (const CMPIBroker *mb, const CMPIObjectPath *instPath, CMPIStatus *rc)
	Create a new CMPIInstance object initialized to a given instance path. More...
static CMPIObjectPath *	CMNewObjectPath (const CMPIBroker *mb, const char *ns, const char *cn, CMPIStatus *rc)
	Create a new CMPIObjectPath initialized to a given namespace and class name. More...
static CMPIArgs *	CMNewArgs (const CMPIBroker *mb, CMPIStatus *rc)
	Create a new CMPIArgs object initialized to have no method parameters. More...
static CMPIString *	CMNewString (const CMPIBroker *mb, const char *data, CMPIStatus *rc)
	Create a new CMPIString object initialized from a C-language string. More...
static CMPIArray *	CMNewArray (const CMPIBroker *mb, CMPICount size, CMPIType type, CMPIStatus *rc)
	Create a new CMPIArray object of a given size and type of elements. More...
static CMPIDateTime *	CMNewDateTime (const CMPIBroker *mb, CMPIStatus *rc)
	Create a new CMPIDataTime object to the current date and time. More...
static CMPIDateTime *	CMNewDateTimeFromBinary (const CMPIBroker *mb, CMPIUint64 binTime, CMPIBoolean interval, CMPIStatus *rc)
	Create a new CMPIDateTime object initialized to a specific value. More...
static CMPIDateTime *	CMNewDateTimeFromChars (const CMPIBroker *mb, const char *datetime, CMPIStatus *rc)
	Create a new CMPIDateTime object initialized to a specified value. More...
static CMPISelectExp *	CMNewSelectExp (const CMPIBroker *mb, const char *query, const char *lang, CMPIArray **projection, CMPIStatus *rc)
	Create a new CMPISelectExp object initialized from a select expression specified in a query language. More...
static CMPIError *	CMNewCMPIError (const CMPIBroker *mb, const char *owner, const char *msgID, const char *msg, const CMPIErrorSeverity sev, const CMPIErrorProbableCause pc, const CMPIrc cimStatusCode, CMPIStatus *rc)
	Create a new CMPIError object initialized with certain core attributes. More...
static CMPIPropertyList *	CMNewPropertyList (const CMPIBroker *mb, const char **properties, CMPIStatus *rc)
	Create a new CMPIPropertyList object initialized to a list of property names. More...
static CMPIString *	CMNewStringCP (const CMPIBroker *mb, const char *data, const CMPICodepageID cpid, CMPIStatus *rc)
	Create a new CMPIString object from a C-language string in a specific codepage. More...
static CMPIEnumerationFilter *	CMNewEnumerationFilter (const CMPIBroker *mb, const char *filterQueryLanguage, const char *filterQuery, CMPIStatus *rc)
	Create a new CMPIEnumerationFilter object initialized with a filter query. More...
static CMPIBoolean	CMClassPathIsA (const CMPIBroker *mb, const CMPIObjectPath *classPath, const char *className, CMPIStatus *rc)
	Test whether a class path is of a specified class or any of its subclasses. More...
static CMPIString *	CDToString (const CMPIBroker *mb, const void *object, CMPIStatus *rc)
	Convert an encapsulated data type object into a string representation. More...
static CMPIBoolean	CDIsOfType (const CMPIBroker *mb, const void *object, const char *type, CMPIStatus *rc)
	Test whether an encapsulated data type object is of a specified CMPI type. More...
static CMPIString *	CDGetType (const CMPIBroker *mb, const void *object, CMPIStatus *rc)
	Get the type name of an ensapsulated data type object. More...
static CMPIStatus	CMLogMessage (const CMPIBroker *mb, CMPISeverity severity, const char *id, const char *text, const CMPIString *string)
	Log a diagnostic message. More...
static CMPIStatus	CMTraceMessage (const CMPIBroker *mb, CMPILevel level, const char *component, const char *text, const CMPIString *string)
	Trace a diagnostic message with a specific trace level and component. More...
static CMPIStatus	CMOpenMessageFile (const CMPIBroker *mb, const char *msgFile, CMPIMsgFileHandle *msgFileHandle)
	Open a message file and return a handle to the file. More...
static CMPIStatus	CMCloseMessageFile (const CMPIBroker *mb, const CMPIMsgFileHandle msgFileHandle)
	Close a message file. More...
static CMPIGcStat *	CMMemMark (const CMPIBroker *mb, CMPIStatus *rc)
	Mark a new object lifecycle level for subsequent newly created CMPI encapsulated data type objects. More...
static CMPIStatus	CMMemRelease (const CMPIBroker *mb, const CMPIGcStat *gc)
	Release all CMPI encapsulated data type objects created at the specified object lifecycle level, and remove that level. More...
static void *	CMMalloc (const CMPIBroker *mb, size_t size)
	Allocate an uninitalized memory block of the specified size. More...
static void *	CMCalloc (const CMPIBroker *mb, size_t nElems, size_t sizeElem)
	Allocate a memory block of the specified size and initialize it to zero. More...
static void *	CMRealloc (const CMPIBroker *mb, void *ptr, size_t size)
	Change the size of a memory block. More...
static void *	CMStrDup (const CMPIBroker *mb, const char *str)
	Allocate a memory block and initialize it with a string. More...
static void	CMFree (const CMPIBroker *mb, void *ptr)
	Release a memory block. More...
static void	CMFreeInstance (const CMPIBroker *mb, CMPIInstance *inst)
	Release a CMPIInstance object. More...
static void	CMFreeObjectPath (const CMPIBroker *mb, CMPIObjectPath *obj)
	Release a CMPIObjectPath object. More...
static void	CMFreeArgs (const CMPIBroker *mb, CMPIArgs *args)
	Release a CMPIArgs object. More...
static void	CMFreeString (const CMPIBroker *mb, CMPIString *str)
	Release a CMPIString object. More...
static void	CMFreeArray (const CMPIBroker *mb, CMPIArray *array)
	Release a CMPIArray object. More...
static void	CMFreeDateTime (const CMPIBroker *mb, CMPIDateTime *dt)
	Release a CMPIDateTime object. More...
static void	CMFreeSelectExp (const CMPIBroker *mb, CMPISelectExp *se)
	Release a CMPISelectExp object. More...
static void	CMFreeChars (const CMPIBroker *mb, char *chars)
	Free the memory of a C-language string. More...

Detailed Description

Defines CMPI convenience functions that ease the use of the various function tables.

MIs that intend to use the CMPI convenience functions need to include this header file.

This header file belongs to the Open Group Technical Standard: Systems Management: Common Manageability Programming Interface (CMPI Standard), Issue 2 Version 1.

This header file is provided as a convenience only. In the case of any discrepancy between the header file and the CMPI Standard (incorporating any subsequent Technical Corrigenda), the CMPI Standard shall be definitive.