L_DicomAddPresStateImageRefByDS

#include "l_bitmap.h"

L_LTDIC_API L_UINT16 L_DicomAddPresStateImageRefByDS(hDS, hRefImageDS, FrameNumbers, uFramesCount)

HDICOMDS hDS;	/* a DICOM handle */
HDICOMDS hRefImageDS;	/* a DICOM handle for the data set to be referenced */
L_INT32* FrameNumbers;	/* array of frame numbers */
L_UINT uFramesCount;	/* size of the array */

Adds a new item to the "Referenced Image Sequence" under the "Presentation State Module"

Parameter	Description
hDS	A DICOM handle.
hRefImageDS	Dataset which represents the image(SOP Instance) to be referenced.
FrameNumbers	An array which represents the frame numbers inside the image (SOP Instance) to which the presentation state will be applied.
uFramesCount	Number of frames being set.

Returns

DICOM_SUCCESS	The function was successful.
>0	An error occurred. Refer to Return Codes.

Comments

This function will add a new item into the "Referenced Image Sequence" (0008,1140) under the "Presentation State Module", by passing a dataset, which represents the image (SOP Instance) to be referenced.

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:	L_DicomSetPresStateInfo, L_DicomGetPresStateInfo, L_DicomRemovePresStateImageRefBySOPInstance, L_DicomRemoveAllPresStateImageRefs, L_DicomGetPresStateImageRefSOPInstance, L_DicomGetPresStateImageRefCount, L_DicomFindFirstPresStateRefSeriesItem, L_DicomFindNextPresStateRefSeriesItem, L_DicomGetPresStateImageRefBySOPInstance
Topics:	Working with DICOM Annotations
	Dicom Annotations: Presentation State Module
	How to Disable the Automatic Loading of the default DICOM IOD Table

Example

L_INT DicomAddPresStateImageRefByDSExample(HDICOMDS hPresStateDS, HDICOMDS hImageDS)
{
   L_UINT16    nRet = DICOM_SUCCESS;
   L_UINT      uFramesCount = 2; 
   L_INT32*    FrameNumbers = new L_INT32[uFramesCount]; 
   FrameNumbers[0] = 1; 
   FrameNumbers[1] = 12; 
   nRet = L_DicomAddPresStateImageRefByDS( hPresStateDS, hImageDS, FrameNumbers, uFramesCount); 
   if (nRet == DICOM_SUCCESS) 
   {
      MessageBox( NULL, 
                  TEXT("Image was successfully added to the referenced image sequence."), 
                  TEXT("Success"), 
                  MB_OK);          
   }
   if (FrameNumbers) 
   {
      delete [] FrameNumbers; 
   }
   return nRet;
}