LContainer::GetOffset

Summary

Gets the current container coordinates offset values.

Syntax

#include "Ltwrappr.h"

L_INT LContainer::GetOffset (pnXOffset, pnYOffset, pnZOffset)

Parameters

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

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

Example

L_INT LContainer_GetOffsetExample( LContainer &lCont )  
 
{ 
   L_INT nRet; 
 
   nRet = lCont.IsValid ( ); 
 
   if ( nRet == SUCCESS ) /* check the validity of container handle */ 
 
   { 
 
      L_INT x, y, z ;  
 
      /* get the current offset values for the container */ 
 
      nRet = lCont.GetOffset ( &x, &y, &z ) ;  
      if(nRet != SUCCESS) 
         return nRet; 
 
      x ++ ;  
 
      y ++ ;  
 
      /* set the current offset values for the container */ 
 
      nRet = lCont.SetOffset ( x, y, z ) ;  
      if(nRet != SUCCESS) 
         return nRet; 
 
   } 
 
   else 
 
   { 
 
      return nRet ; 
 
   } 
 
   return SUCCESS ;  
 
}