L_ContainerGetOffset

#include "LtCon.h"

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

pCONTAINERHANDLE pContainer;	/* pointer to a container handle */
L_INT *pnXOffset;	/* pointer to get the x-coordinates offset */
L_INT *pnYOffset;	/* pointer to get the y-coordinates offset */
L_INT *pnZOffset;	/* pointer to get the z-coordinates offset */

Gets the current container coordinates offset values.

Parameter	Description
pContainer	Pointer to a container handle.
pnXOffset	Pointer to the value that will receive the offset of the external representation in the x direction.
pnYOffset	Pointer to the value that will receive the offset of the external representation in the y direction.
pnZOffset	Pointer to the value that will receive the offset of the external representation in the z direction.

Returns

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

LTCON

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application

See Also

Functions:	L_ContainerSetOffset.
Topics:	Container Offsets

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;
}