L_LTANN_API L_INT L_AnnSetUser(hObject, pOldUser, pNewUser, uFlags)
Sets the user string for the specified object.
Handle to the annotation object.
Character string that contains the old user string.
Character string that contains the new user string.
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:
|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.|
|SUCCESS||The function was successful.|
|< 1||An error occurred. Refer to Return Codes.|
If the specified object does not have a specified user, set
pOldUser to NULL and set
pNewUser to the new user string.
To change an objects user, set pOldUser to the old user string and set pNewUser to the new user string. For any object having a specified user, you must know the old user string in order to change the user.
You can change an object from having a specified user to having no user by setting pOldUser to the old user string and setting pNewUser to NULL.
Please note that when using
uFlags to change the user on more than one object, only those objects with a user set to pOldUser will be changed. For example, if you set
pOldUser to "YourObject" and set pNewUser to "MyObject", and set uFlags to ANNFLAG_RECURSE | ANNFLAG_NOTCONTAINER, only those objects having user "YourObject" will be changed. Objects with other users, or with NULL users will not be modified.
Required DLLs and Libraries
For an example, refer to L_AnnGroup.
Medical Web Viewer .NET
.NET, Java, Android, and iOS/macOS Assemblies
C API/C++ Class Libraries