LAnnotation::SetUser

#include "ltwrappr.h"

virtual L_INT LAnnotation::SetUser(pOldUser, pNewUser, uFlags=0)

L_TCHAR * pOldUser;	/* old user string */
L_TCHAR * pNewUser;	/* new user string */
L_UINT uFlags;	/* flags that determine which objects to process */

Sets the user string for the specified object.

Parameter	Description
pOldUser	Character string that contains the old user string.
pNewUser	Character string that contains the new user string.
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 LAnnContainer::GetSelectItems and LAnnotation::SetSelected 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.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

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

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

Win32, x64.

See Also

Functions:	LAnnotation::Unlock, LAnnotation::ShowLockedIcon
Topics:	Annotation Functions: Security
	Annotation Objects - Automated Features

Example

//Beginning of CVAnnotationToolvar11dlg::OnButtonAnnSeruser()

//This examples shows how to enumerate annotations in an LAnnotationWindow object

//This example uses the following member variables:

// LAnnotationWindow m_AnnotationWindow

// m_AnnotationWindow should be created and initialized (using CreateWnd) prior to the example

class LUserAnnContainer : public LAnnContainer
{
   public:
      L_INT   m_nObjectCount ;
   public:
      LUserAnnContainer(HANNOBJECT hAnnObject);
      virtual ~LUserAnnContainer() ;
      virtual L_INT EnumerateCallBack(HANNOBJECT hObject);
};
LUserAnnContainer::LUserAnnContainer(HANNOBJECT hAnnObject):LAnnContainer(hAnnObject)
{
   m_nObjectCount = 0 ;
}
LUserAnnContainer::~LUserAnnContainer()
{
}
L_INT LUserAnnContainer::EnumerateCallBack(HANNOBJECT hObject)
{
   UNREFERENCED_PARAMETER(hObject);
   m_nObjectCount++ ;
   L_TCHAR szTemp[100];
   wsprintf(szTemp, TEXT("[%d]Annotation object"), m_nObjectCount); 
   AfxMessageBox(szTemp);
   return SUCCESS ;
}
L_INT LAnnotation_SetUserExample()
{
   LAnnContainer AnnContainer;
   LAnnotationWindow m_AnnotationWindow;
   AnnContainer = m_AnnotationWindow.GetContainerObject();
   AnnContainer.SetUser(NULL, TEXT("TestName"), ANNFLAG_RECURSE);
   //Enumerating objects return nothing--did not pass a valid user
   AfxMessageBox(TEXT("Passing Invalid User to Enumerate"));
   LUserAnnContainer UserAnnContainer(AnnContainer.GetHandle());
   UserAnnContainer.m_nObjectCount=0;
   UserAnnContainer.Enumerate(ANNFLAG_RECURSE|ANNFLAG_NOTCONTAINER|ANNFLAG_USER);
   //Enumerating objects this time returns all the objects--valid user
   AfxMessageBox(TEXT("Passing Valid User to Enumerate"));
   UserAnnContainer.m_nObjectCount=0;
   UserAnnContainer.Enumerate(ANNFLAG_RECURSE|ANNFLAG_NOTCONTAINER|ANNFLAG_USER, TEXT("Terry"));
   return SUCCESS;
}
//End of AnnSetuserTest()