LDicomDS::GetBinaryValue

#include "Ltdic.h"

L_BOOL LDicomDS::GetBinaryValue(pElement, pValue, nLength)

pDICOMELEMENT pElement;	/* pointer to a DICOMELEMENT structure */
L_VOID * pValue;	/* pointer to a buffer */
L_UINT32 nLength;	/* length of the buffer */

Updates a buffer with a binary value.

Parameter	Description
pElement	Pointer to a DICOMELEMENT structure within the Data Set.
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.
nLength	Length, in bytes, of the buffer you allocated.

Returns

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

See Also

Functions:	LDicomDS::GetCharValue, LDicomDS::GetShortValue, LDicomDS::GetLongValue, LDicomDS::GetFloatValue, LDicomDS::GetDoubleValue, LDicomDS::GetStringValue, LDicomDS::GetAgeValue, LDicomDS::GetDateValue, LDicomDS::GetTimeValue, LDicomDS::GetDateTimeValue
Topics:	Working with Data Sets
	How to Disable the Automatic Loading of the default DICOM IOD Table

Example

This example gets the binary value for an element.

L_INT LDicomDS_GetBinaryValueExample()
{
   LDicomDS      *pDS;
   pDICOMELEMENT  pElement;
   L_CHAR         szText[256];
   pDS = new LDicomDS(NULL);
   pDS->InitDS( CLASS_XA_BIPLANE_IMAGE_STORAGE_RETIRED, 0); 
   pElement = pDS->FindFirstElement(NULL, TAG_PATIENT_NAME, FALSE);
   if (pElement != NULL)
   {
      memset(szText, 0, sizeof(szText));
      pDS->GetBinaryValue(pElement, szText, sizeof (szText)-1);
   }
   delete pDS;
   return DICOM_SUCCESS;
}