OpenClovis Logo

Typedefs | Enumerations | Functions
clCorUtilityApi.h File Reference

Header File of COR utility APIs. More...

#include <clCommon.h>
#include <clOmCommonClassTypes.h>
#include "clCorMetaData.h"
#include "clCorServiceId.h"

Go to the source code of this file.

Typedefs

typedef enum ClCorClsCfgType ClCorClsCfgTypeT
 Class specification.
 

Enumerations

enum  ClCorClsCfgType
 Class specification.
 
enum  ClCorPersDataTypeT {
  CL_COR_PERS_CLASS_DATA = 1 ,
  CL_COR_PERS_HIER_DATA ,
  CL_COR_PERS_OBJ_DATA ,
  CL_COR_PERS_RM_DATA ,
  CL_COR_PERS_NI_DATA ,
  CL_COR_PERS_DATA_MAX
}
 Pre-provisioning related structures. More...
 

Functions

ClRcT clCorAttrPathAlloc (CL_INOUT ClCorAttrPathPtrT *pAttrPath)
 Creates an attribute path. More...
 
ClRcT clCorAttrPathAppend (CL_INOUT ClCorAttrPathPtrT pAttrPath, CL_IN ClCorClassTypeT attrId, CL_IN ClCorInstanceIdT index)
 Adds an entry to the attribute path. More...
 
ClRcT clCorAttrPathClone (ClCorAttrPathPtrT pAttrPath, ClCorAttrPathPtrT *newH)
 Clones a particular ClCorAttrPath. More...
 
ClInt32T clCorAttrPathCompare (CL_IN ClCorAttrPathPtrT pAttrPath, CL_IN ClCorAttrPathPtrT cmp)
 Compares two ClCorAttrPath. More...
 
ClInt16T clCorAttrPathDepthGet (CL_IN ClCorAttrPathPtrT pAttrPath)
 Returns the COR attribute path node depth. More...
 
ClRcT clCorAttrPathFree (CL_INOUT ClCorAttrPathPtrT pAttrPath)
 Deletes the COR attribute path handle. More...
 
ClUint32T clCorAttrPathIndexGet (CL_IN ClCorAttrPathPtrT pAttrPath)
 Returns the index of COR attribute path. More...
 
ClRcT clCorAttrPathIndexSet (CL_INOUT ClCorAttrPathPtrT pAttrPath, CL_IN ClUint16T ndepth, CL_IN ClUint32T newIndex)
 Sets the index of COR attribute path. More...
 
ClRcT clCorAttrPathInitialize (CL_INOUT ClCorAttrPathPtrT pAttrPath)
 Initializes the attribute path. More...
 
ClRcT clCorAttrPathSet (CL_INOUT ClCorAttrPathPtrT pAttrPath, CL_IN ClUint16T level, CL_IN ClCorAttrIdT attrId, CL_IN ClUint32T index)
 Sets the attribute ID for a given node. More...
 
void clCorAttrPathShow (CL_IN ClCorAttrPathPtrT pAttrPath)
 Displays the COR attribute path in debug mode only. More...
 
ClCorAttrIdT clCorAttrPathToAttrIdGet (CL_IN ClCorAttrPathPtrT pAttrPath)
 Returns the attribute ID. More...
 
ClRcT clCorAttrPathTruncate (CL_INOUT ClCorAttrPathPtrT pAttrPath, CL_IN ClInt16T level)
 Removes node after specified level. More...
 
ClRcT clCorMoIdAlloc (CL_INOUT ClCorMOIdPtrT *pMoId)
 Creates an MoId. More...
 
ClRcT clCorMoIdAppend (CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClCorClassTypeT type, CL_IN ClCorInstanceIdT instance)
 Adds an entry to the MoId. More...
 
ClRcT clCorMoIdClone (ClCorMOIdPtrT pMoId, ClCorMOIdPtrT *newH)
 Clones a particular MOId. More...
 
int clCorMoIdCompare (CL_IN ClCorMOIdPtrT pMoId, CL_IN ClCorMOIdPtrT cmp)
 Compares two MoIds and verifies if they are equal. More...
 
ClRcT clCorMoIdConcatenate (CL_INOUT ClCorMOIdPtrT part1, CL_INOUT ClCorMOIdPtrT part2, CL_IN ClInt32T copyWhere)
 Concatenates a MoId to another MoId. More...
 
ClInt16T clCorMoIdDepthGet (CL_IN ClCorMOIdPtrT pMoId)
 Returns node depth of the COR MoId. More...
 
ClRcT clCorMoIdFirstInstanceGet (CL_INOUT ClCorMOIdPtrT pMoId)
 Returns the first child. More...
 
ClRcT clCorMoIdFree (CL_INOUT ClCorMOIdPtrT pMoId)
 Deletes the ClCorMOId handle. More...
 
ClRcT clCorMoIdInitialize (CL_INOUT ClCorMOIdPtrT pMoId)
 Initializes a MOID or resets the content of an existing MOID. More...
 
ClRcT clCorMoIdInstanceSet (CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClUint16T ndepth, CL_IN ClCorInstanceIdT newInstance)
 Sets the instance of the MoId. More...
 
ClRcT clCorMoIdNameToMoIdGet (CL_IN ClNameT *moIdName, CL_OUT ClCorMOIdT *moId)
 Retrieves moId in ClCorMOIdT format, when moId is provided in ClNameT format. More...
 
ClRcT clCorMoIdNextSiblingGet (CL_INOUT ClCorMOIdPtrT pMoId)
 Returns the next sibling. More...
 
ClCorMOServiceIdT clCorMoIdServiceGet (CL_IN ClCorMOIdPtrT pMoId)
 Returns the service ID. More...
 
ClRcT clCorMoIdServiceSet (CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClCorMOServiceIdT svc)
 Sets the service ID. More...
 
ClRcT clCorMoIdSet (CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClUint16T level, CL_IN ClCorClassTypeT type, CL_IN ClCorInstanceIdT instance)
 Sets the class type and instanceId at a given node or level. More...
 
void clCorMoIdShow (CL_IN ClCorMOIdPtrT pMoId)
 Displays the ClCorMOId handle. More...
 
ClRcT clCorMoIdToClassGet (CL_IN ClCorMOIdPtrT pMoId, CL_IN ClCorMoIdClassGetFlagsT flag, CL_OUT ClCorClassTypeT *pClassId)
 Returns the class type. More...
 
ClCorInstanceIdT clCorMoIdToInstanceGet (CL_IN ClCorMOIdPtrT pMoId)
 Returns the instance. More...
 
ClRcT clCorMoIdToMoClassPathGet (CL_IN ClCorMOIdPtrT moIdh, CL_OUT ClCorMOClassPathPtrT corIdh)
 Derives the COR path from given a MoId. More...
 
ClRcT clCorMoIdToMoIdNameGet (CL_IN ClCorMOIdT *moId, CL_OUT ClNameT *moIdName)
 Retrieves MoId in ClNameT format, when MoId is provided in ClCorMOIdT format. More...
 
ClRcT clCorMoIdTruncate (CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClInt16T level)
 Removes the node after specified level. More...
 
ClRcT clCorMoIdValidate (CL_IN ClCorMOIdPtrT pMoId)
 Validates MoId in the input argument. More...
 
ClRcT clCorServiceIdValidate (CL_IN ClCorServiceIdT srvcId)
 Validates serviceId in the input argument. More...
 
ClRcT clCorUtilMoAndMSOCreate (CL_IN ClCorMOIdPtrT pMoId, CL_OUT ClCorObjectHandleT *pHandle)
 Creates MO and MSO objects. More...
 
ClRcT clCorUtilMoAndMSODelete (CL_IN ClCorMOIdPtrT pMoId)
 Deletes MO and MSO objects. More...
 

Detailed Description

Header File of COR utility APIs.


Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen