L_VecGetObjectDescription

Summary

Retrieves the description string for the specified vector object.

Syntax

L_LVKRN_API L_UINT32 L_VecGetObjectDescription(pVector, pObject, pBuffer, uSize)

Parameters

pVECTORHANDLE pVector

Pointer to the vector handle.

const pVECTOROBJECT pObject

Pointer to a VECTOROBJECT structure that contains the vector object for which to get the description.

L_TCHAR * pBuffer

Pointer to a buffer to be updated with the object description string.

L_UINT32 uSize

Size of the buffer allocated for pBuffer.

Returns

If pBuffer is NULL, it will return the size of the buffer required for the description string. If pBuffer is not NULL, it will return the number of bytes actually written to the buffer.

Required DLLs and Libraries

• LTVKRN
• 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_VecSetObjectDescription

Topics

• Getting Vector Object Information
• Working with Vector Objects

Example

L_INT VecGetObjectDescriptionExample( 
   pVECTORHANDLE pVector, 
   pVECTOROBJECT pObject) 
{ 
   L_INT    nRet; 
   L_UINT32 uSize; 
   L_TCHAR* pszDesc; 
 
   nRet  = SUCCESS; 
   uSize = L_VecGetObjectDescription ( pVector, pObject, NULL, 0 ); 
   if( uSize > 0 ) 
   { 
      pszDesc = (L_TCHAR*) malloc( sizeof( L_TCHAR ) * uSize ); 
      if( NULL == pszDesc ) 
         return ERROR_NO_MEMORY; 
 
      L_VecGetObjectDescription ( pVector, pObject, pszDesc, sizeof( L_TCHAR ) * uSize ); 
 
      if( uSize > 4 ) 
      { 
         pszDesc[ 0 ] = 'T'; 
         pszDesc[ 1 ] = 'E'; 
         pszDesc[ 2 ] = 'S'; 
         pszDesc[ 3 ] = 'T'; 
 
         nRet = L_VecSetObjectDescription ( pVector, pObject, pszDesc ); 
      } 
      free( pszDesc ); 
   } 
 
   return nRet; 
}