SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Types
SE_Predicate
/*
 * TYPEDEF: SE_Predicate
 *
 *   Defines a type for a pointer to a user-defined function that can
 *   be used in a search filter. The user-defined function must match
 *   this signature, and returns true or false based on whether the given
 *   test_object passes the tests the user-supplied test function.  If
 *   a link class object was encountered when retrieving the test_object, then
 *   that link class object is also made available to the user for testing
 *   within the test function.
 *
 *   Furthermore, a user can pass in an address to some arbitrary "test_data",
 *   was previously set by the user to hold some information that the function
 *   will use during the testing of the test_object.
 *
 *   This API does not know (and never uses) the contents of this test_data.
 *   As an iterator is traversing objects, determining whether an object will
 *   be returned to the user, the objects will be tested against any test-
 *   functions that the user has defined through SE_Predicate search rules for
 *   that iterator.
 */
typedef SE_Boolean (*SE_Predicate)
(
SE_Object test_object,
SE_Object link_class_object,
void *test_data
);



Prev: SE_Parallelepiped_Volume_Extent_Entry. Next: SE_Quadrant_Select_Parameters.


Return to: Top of this Page, Type Index

Last updated: July 16, 2004 Copyright © 2004 SEDRIS