Callback function for PBORCA_ObjectQueryHierarchy

Description

Called for each ancestor object in the hierarchy of the object being examined. In the callback function, you can save the ancestor name for later display.

Syntax

typedef void (CALLBACK *PBORCA_HIERPROC) 
             ( PPBORCA_HIERARCHY, LPVOID );

Argument

Description

PPBORCA_HIERARCHY

Pointer to the PBORCA_HIERARCHY structure (described next)

LPVOID

Long pointer to user data


Return value

None.

Usage

You provide the code for the callback function. The callback function generally reads the ancestor name passed in the PBORCA_HIERARCHY structure and saves it in the user data buffer pointed to by LPVOID.

The user data buffer is allocated in the calling program and can be structured any way you want. It might include a structure that counts the number of ancestors and an array or text block in which you store the names.

For information and examples of coding a callback function, see About ORCA callback functions.