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
}
 Pre-provisioning related structures. More...

Functions

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

Detailed Description

Header File of COR utility APIs.


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