L_AnnGetContainer
#include "l_bitmap.h"
L_INT EXT_FUNCTION L_AnnGetContainer(hObject, phContainer)
|
HANNOBJECT hObject; |
/* handle to the annotation object */ |
|
pHANNOBJECT phContainer; |
/* address of the variable to be updated */ |
Gets the handle of the container of the specified annotation object. This function is available in the Document/Medical Toolkits.
|
Parameter |
Description |
|
hObject |
Handle to the annotation object. |
|
phContainer |
Address of the HANNOBJECT variable to be updated with the handle of the container. If the object does not have a container, the updated value is NULL. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Before calling this function, you must declare a variable of data type HANNOBJECT. Then, pass the address of the variable in the phContainer parameter. This function will update the variable with the handle of the annotation object's container.
Required DLLs and Libraries
|
LTANN For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
Platforms
Windows 95 / 98 / Me, Windows 2000 / XP.
See Also
|
Functions: |
L_AnnInsert, L_AnnRemove, L_AnnGetTopContainer, L_AnnEnumerate, L_AnnGetItem |
|
Topics: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
/* This example compares the immediate container to the root container */
void TestAnnGetContainer(HANNOBJECT hAnnObject)
{
HANNOBJECT ThisContainer; /* Container for this object */
HANNOBJECT TopContainer; /* Root container for the whole window */
/* Get both the immediate container and the root container */
L_AnnGetContainer(hAnnObject, &ThisContainer);
L_AnnGetTopContainer(hAnnObject, &TopContainer);
/* Compare the container handles */
if (ThisContainer == TopContainer)
MessageBox (NULL, TEXT("Top-level object"), TEXT("Notice"), MB_OK);
else
MessageBox (NULL, TEXT("Object in a sub-container"), TEXT("Notice"), MB_OK);
return;
}