L_ContainerGetObjectCursor

Summary

Gets a copy of the specified container object cursor.

Syntax

#include "LtCon.h"

L_LTCON_API L_INT L_ContainerGetObjectCursor(pContainer, nObjectType, phCursor )

Parameters

pCONTAINERHANDLE pContainer

Pointer to a container handle.

CONTAINEROBJECTTYPE nObjectType

An integer value that represents the object for which to get the cursor.

L_HCURSOR * phCursor

Pointer to the variable to be updated with the cursor.

Returns

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

Comments

The user is responsible for deleting the received cursor.

When phCursor is no longer needed, it should be deleted.

Required DLLs and Libraries

See Also

Functions

Topics

Example

L_INT ContainerGetObjectCursorExample(pCONTAINERHANDLE   pContainer, 
                                                      HCURSOR*           phCur) 
{ 
   L_INT nRet; 
 
   nRet = L_ContainerIsValid ( pContainer ); 
   if ( nRet == SUCCESS) /* check the validity of container handle */ 
   { 
      HCURSOR hCursor ; 
 
      /* get the container line object cursor */ 
      nRet = L_ContainerGetObjectCursor ( pContainer, CONTAINER_OBJECT_TYPE_LINE, &hCursor ) ; 
      if(nRet != SUCCESS) 
         return nRet; 
 
      *phCur = (HCURSOR) CopyImage ( phCur, IMAGE_CURSOR, 0, 0, 0 ) ; 
 
      return SUCCESS ; 
   } 
   else 
   { 
      return nRet; 
   } 
 
} 
Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Container and Automation C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.