OpenClovis Logo

Public Attributes | List of all members
ClCorObjAttrWalkFilter Struct Reference

The structure ClCorObjAttrWalkFilter is used to specify filter properties while performing attribute walk operation. More...

#include <clCorMetaData.h>

Public Attributes

ClCorAttrIdT attrId
 This must contain either a valid attribute ID or CL_COR_INVALID_ATTR_ID.
ClCorAttrWalkOpT attrWalkOption
 The attrWalkOption can be set to CL_COR_ATTR_WALK_ALL_ATTR or CL_COR_ATTR_WALK_ONLY_MATCHED_ATTR.
ClUint8T baseAttrWalk
 This is a depreciated feature and must be CL_TRUE for attribute walk.
ClCorAttrCmpFlagT cmpFlag
 The comparison flag is used to compare an attribute ID against a specified value.
ClUint8T contAttrWalk
 This is a depricated feature and must be CL_FALSE for attribute walk.
ClInt32T index
 It is used to specify the index for ARRAY attributes.
ClCorAttrPathTpAttrPath
 This is a depricated feature and must be NULL for attribute walk.
ClUint32T size
 Size of the value.
void * value
 Pointer to the value.

Detailed Description

The structure ClCorObjAttrWalkFilter is used to specify filter properties while performing attribute walk operation.

Member Data Documentation

ClCorAttrIdT ClCorObjAttrWalkFilter::attrId

This must contain either a valid attribute ID or CL_COR_INVALID_ATTR_ID.

If the value is set to CL_COR_INVALID_ATTR_ID, no attribute value comparison is performed.

ClCorAttrWalkOpT ClCorObjAttrWalkFilter::attrWalkOption

The attrWalkOption can be set to CL_COR_ATTR_WALK_ALL_ATTR or CL_COR_ATTR_WALK_ONLY_MATCHED_ATTR.

Note
This value will not be processed if attrId is CL_COR_INVALID_ATTR_ID.
ClCorAttrCmpFlagT ClCorObjAttrWalkFilter::cmpFlag

The comparison flag is used to compare an attribute ID against a specified value.

Following are the comparison flags

  • CL_COR_ATTR_CMP_FLAG_VALUE_EQUAL_TO: The attributes whose value is equal to the specified value is matched.
  • CL_COR_ATTR_CMP_FLAG_VALUE_LESS_THAN: The attributes whose value is greater than the specified value is matched.
  • CL_COR_ATTR_CMP_FLAG_VALUE_LESS_OR_EQUALS: The attributes whose value is greater than or equal to the specified value is matched.
  • CL_COR_ATTR_CMP_FLAG_VALUE_GREATER_THAN: The attributes whose value is less than the specified value is matched.
  • CL_COR_ATTR_CMP_FLAG_VALUE_GREATER_OR_EQUALS: The attributes whose value is less than or equal to the specified value is matched.
    Note
    This value will not be processed if attrId is CL_COR_INVALID_ATTR_ID.
ClInt32T ClCorObjAttrWalkFilter::index

It is used to specify the index for ARRAY attributes.

For a SIMPLE attribute, the index is set to CL_COR_INVALID_ATTR_IDX.

Note
This value will not be processed if attrId is CL_COR_INVALID_ATTR_ID.
ClUint32T ClCorObjAttrWalkFilter::size

Size of the value.

Note
This value will not be processed if attrId is CL_COR_INVALID_ATTR_ID.
void* ClCorObjAttrWalkFilter::value

Pointer to the value.

Note
This value will not be processed if attrId is CL_COR_INVALID_ATTR_ID.

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