In This Topic ▼

L_DicomGetBinaryValue

Summary

Updates a buffer with a binary value.

Syntax

#include "Ltdic.h"

L_LTDIC_API L_BOOL L_DicomGetBinaryValue(hDS, pElement, pValue, nLength)

Parameters

pDICOMELEMENT pElement

Pointer to a DICOMELEMENT structure within the Data Set.

L_VOID * pValue

Buffer that will be updated with the value of the binary value associated with the specified item in the Data Set. You are responsible for allocating the memory for this buffer.

L_UINT32 nLength

Length, in bytes, of the buffer you allocated.

Returns

Value	Meaning
TRUE	The function is able to update the buffer with the binary value.
FALSE	The function cannot update the buffer with a binary value.

Comments

Note: You must allocate the memory for pValue.

The DICOMELEMENT structure has a member also called nLength. If this nLength value is greater than the nLength of the buffer you allocated (pValue), then the binary value copied into pValue will be truncated to the smaller length. If the nLength of the DICOMELEMENT is shorter than the nLength of pValue, the entire binary value associated with the DICOMELEMENT will be copied into pValue.

This function can be called for every Value Representation, and it will return the exact value in the Value Field (unconverted).

Required DLLs and Libraries

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

Platforms

Win32, x64, Linux.

Example

This example gets the binary value for an element

L_INT DicomGetBinaryValueExample(L_VOID) 
{ 
   HDICOMDS hDS; 
   pDICOMELEMENT pElement; 
   L_UCHAR szText[256]; 
 
   hDS = L_DicomCreateDS(NULL); 
 
   L_DicomInitDS(hDS, CLASS_XA_BIPLANE_IMAGE_STORAGE_RETIRED, 0);  
 
   pElement = L_DicomFindFirstElement(hDS, NULL, TAG_PATIENT_NAME, FALSE); 
   if (pElement != NULL) 
   { 
      memset(szText, 0, sizeof(szText)); 
      L_DicomGetBinaryValue(hDS, pElement, szText, sizeof (szText)-1); 
   } 
 
   L_DicomFreeDS(hDS); 
   return DICOM_SUCCESS; 
}