L_AnnUngroup
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnUngroup(hObject, uFlags, pUserList)
|
HANNOBJECT hObject; |
/* handle to the container object */ |
|
L_UINT uFlags; |
/* flags that determine which objects to process */ |
|
L_TCHAR *pUserList; |
/* list of users */ |
Ungroups a group of objects. This function is available in the Document/Medical Toolkits.
|
Parameter |
Description |
|
|
hObject |
Handle to the annotation object. |
|
|
uFlags |
Flags that determine which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( | ). The following are valid values: |
|
|
|
Value |
Meaning |
|
|
0 |
Process only the specified object. |
|
|
ANNFLAG_SELECTED |
[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the L_AnnGetSelected and L_AnnSetSelected functions. |
|
|
ANNFLAG_NOTTHIS |
[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not. |
|
|
ANNFLAG_RECURSE |
[0x0008] Process objects within a container, and within any subcontainers, down to any level. |
|
|
ANNFLAG_NOTCONTAINER |
[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves. |
|
|
ANNFLAG_NOINVALIDATE |
[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages. |
|
|
ANNFLAG_CHECKMENU |
[0x0020] Process objects only if the ANNAUTOTEXT_MENU_UNGROUP menu item has been selected. |
|
|
ANNFLAG_USER |
[0x0040] Ungroup only those objects with users listed in pUserList. |
|
pUserList |
Character string that contains the list of users associated with the specified object. pUserList has the form "User1,User2,,UserN". This must be a NULL terminated string with user names separated by a comma. This parameter is valid only if ANNFLAG_USER is set in uFlags. |
|
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
The Ungroup automation menu item operates like L_AnnUngroup(hContainer, ANNFLAG_RECURSE|ANNFLAG_SELECTED, NULL).
If ANNFLAG_USER is included in uFlags, any user associated with an object to be "ungrouped" must be included in pUserList. The function checks pUserList before ungrouping the objects and any object that has a user not in pUserList will not be ungrouped.
If ANNFLAG_USER is not included in uFlags, the user list is ignored.
Please note that if you include ANNFLAG_SELECTED|ANNFLAG_USER, for example, in uFlags, the objects that will be ungrouped must have a user in pUserList AND must also be selected.
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 2000 / XP/Vista.
See Also
|
Functions: |
|
|
Topics: |
|
|
|
|
|
|
Annotation Functions (Document/Medical only): Grouping and Ungrouping Objects |
|
|
Example
L_INT AnnUngroupExample(HANNOBJECT hContainer)
{
L_INT nRet;
nRet = L_AnnUngroup(hContainer, ANNFLAG_RECURSE | ANNFLAG_NOTCONTAINER, TEXT("MyObject"));
if (nRet == SUCCESS)
MessageBox(NULL, TEXT("Ungrouped."), TEXT(""), MB_OK);
else
return nRet;
return SUCCESS;
}