GetImageBoxInstanceUid Method

Returns the SOP Instance UID of the specified Basic Grayscale/Color Image Box SOP Instance.

Syntax

Visual Basic
C#
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public string GetImageBoxInstanceUid( 
   int index
)

'Declaration
 
Public Function GetImageBoxInstanceUid( _
   ByVal index As Integer _
) As String

'Usage
 
Dim instance As DicomPrintScu
Dim index As Integer
Dim value As String
 
value = instance.GetImageBoxInstanceUid(index)

public string GetImageBoxInstanceUid( 
   int index
)

ObjectiveC Syntax

 function Leadtools.Dicom.DicomPrintScu.GetImageBoxInstanceUid( 
   index 
)

public:
String^ GetImageBoxInstanceUid( 
   int index
)

Parameters

index: The index of the Image Box whose SOP Instance UID is to be retrieved. This should be a number from 0 to the count of Image Boxes minus 1. The method GetImageBoxesCount returns the count of Image Boxes.

Return Value

The SOP Instance UID of the specified Image Box. If an invalid index is passed, the method will return a null reference (Nothing in Visual Basic).

Remarks

When the Print SCP is requested to create a Film Box, it will also create one or more Image Boxes, based on the Image Display Format. This method returns the SOP Instance UID of a particular Image Box.

Example

For an example, refer to Associate(String,Int32,String,String,DicomPrintScuPrintManagementClassFlags).

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DicomPrintScu Class
DicomPrintScu Members
GetImageBoxesCount Method
UpdateImageBox Method
FreeImageBoxesInstanceUids Method
CreateFilmBox Method