#include "ltwrappr.h"
virtual L_INT LAnnNote::DeleteUserHandle(nIndex)
L_INT32 nIndex; |
/* index of the user handle to delete */ |
Deletes an existing user-defined annotation handle.
Parameter |
Description |
nIndex |
Index of the user-defined handle to delete. The index is zero based. Pass -1 to delete all user-defined handles. Passing a negative value other than 1 makes the function return ERROR_INV_PARAMETER. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Call this function to delete a user-defined handle from an annotation object.
Set uIndex to -1 to delete all the user-defined handles.
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. |
Win32, x64.
See Also
Functions: |
Class Members, LAnnNote::AddUserHandle, LAnnNote::EnumerateHandles, LAnnNote::EnumHandleCallBack, LAnnNote::GetUserHandle, LAnnNote::GetUserHandles, LAnnNote::ChangeUserHandle |
Topics: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
// This examples deletes the first user handle of an object
L_INT LAnnNote_DeleteUserHandleExample(LAnnNote *LNote) { L_INT nRet; L_UINT uCount; // Get the total count of user handles nRet = LNote->GetUserHandles(NULL, &uCount); if(nRet != SUCCESS) return nRet; if (uCount > 0) { nRet = LNote->DeleteUserHandle(0); if(nRet != SUCCESS) return nRet; } else { MessageBox(NULL, TEXT("No User Handles!"), TEXT("Error"), MB_OK); return FAILURE; } return SUCCESS; }