L_ContainerGetOffset

#include "LtCon.h"

L_LTCON_API L_INT L_ContainerGetOffset(pContainer, pnXOffset, pnYOffset, pnZOffset)

Gets the current container coordinates offset values.

Parameters

pCONTAINERHANDLE pContainer

Pointer to a container handle.

L_INT *pnXOffset

Pointer to the value that will receive the offset of the external representation in the x direction.

L_INT *pnYOffset

Pointer to the value that will receive the offset of the external representation in the y direction.

L_INT *pnZOffset

Pointer to the value that will receive the offset of the external representation in the z direction.

Returns

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

Comments

The offsets that this function will set will be without any transformations.

Required DLLs and Libraries

See Also

Functions

Topics

Example

L_INT ContainerGetOffsetExample(pCONTAINERHANDLE pContainer) 
{ 
   L_INT nRet; 
 
   nRet = L_ContainerIsValid ( pContainer ); 
   if (nRet == SUCCESS ) /* check the validity of container handle */ 
   { 
      L_INT x, y, z ; 
 
      /* get the current offset values for the container */ 
      nRet = L_ContainerGetOffset ( pContainer, &x, &y, &z ) ; 
      if(nRet != SUCCESS) 
         return nRet; 
 
      x ++ ; 
      y ++ ; 
 
      /* set the current offset values for the container */ 
      nRet = L_ContainerSetOffset ( pContainer, x, y, z ) ; 
   } 
   return nRet; 
} 
Help Version 21.0.2021.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Container and Automation C API Help