virtual L_INT LAnnStamp::DeleteUserHandle(nIndex)
Deletes an existing user-defined annotation handle.
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.
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. Refer to Return Codes. |
Call this function to delete a user-defined handle from the annotation object.
Set nIndex to -1 to delete all the user-defined handles.
Win32, x64.
// This examples deletes the first user handle of an object
L_INT LAnnStamp_DeleteUserHandleExample(LAnnStamp *LStamp)
{
L_INT nRet;
L_UINT uCount;
// Get the total count of user handles
nRet = LStamp->GetUserHandles(NULL, &uCount);
if(nRet != SUCCESS)
return nRet;
if (uCount > 0)
{
nRet = LStamp->DeleteUserHandle(0);
if(nRet != SUCCESS)
return nRet;
}
else
{
MessageBox(NULL, TEXT("No User Handles!"), TEXT("Error"), MB_OK);
return FAILURE;
}
return SUCCESS;
}
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document