$ent->filerefs()

Syntax

$ent->filerefs( [$refkindstring [,$entkindstring 
                 [, $unique ]]] ) 

Description

Returns a list of all references that occur in the specified file entity. These references will not necessarily have the file entity for their ->scope value. Each returned reference is an object in the Understand::Ref class.

Arguments

If the optional argument $refkindstring is not passed, then all references are returned. Otherwise, $refkindstring should be a language-specific reference filter string.

If the optional argument $entkindstring is not passed, then all references to any kind of entity are returned. Otherwise, $entkindstring may be a language-specific entity filter string that specifies references to what kind of referenced entity are to be returned. See Entity and Reference Kinds for lists of kinds.

If the optional argument $unique is passed with value 1, only the first matching reference to each unique entity is returned.


Scientific Toolworks, Inc.
http://www.scitools.com