Function CDM_AnnotationContainsAttributeMatchingValue


Definition:#include <CDM.h>
Prototype:int CDM_AnnotationContainsAttributeMatchingValue(CDM_Annotation Ann, char *AttributeName, char *ValuePattern);
Arguments:

Ann: The Annotation to be examined (CDM_Annotation)
AttributeName: The name of the desired Attribute (char *)
ValuePattern: The pattern the Attribute Value should match (char *)

C/C++ API Sections
Tcl API Sections
Description
Return Value
Notes
See Also
Index

Description:

This function will check the provided Annotation (specified through the "Annotation" parameter) to locate an Attribute that has the specified name (through the "AttributeName" parameter). If such an Attribute is not found in the Annotation, 0 will be returned. If a proper Attribute is found, its value will be matched against the provided (though the "ValuePattern" parameter) pattern: if a match is found 1 will be returned, else this function will return 0.

The pattern specified through the "ValuePattern" parameter must follow the same rules as the patterns used with the "string match" Tcl command.

Return Value:

This function will return 1 (true) if an Attribute with the provided name exists in the specified Annotation, and its value matches the provided pattern. Else, 0 (false) will be returned.

In case of an error, -1 will be returned and an error message will be left at the current Tcl interpreter (CDM_Interp).

Notes:

This function is equivelant to tip_AnnotationContainsAttributeMatchingValue (Tcl API).

See Also:

CDM_AnnotationContainsAttributeMatchingValues, tip_AnnotationContainsAttributeMatchingValue, string match


Generated by: petasis@aias on Wed Aug 16 10:31:57 PM EEST 2006.