Leadtools.Dicom Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
GetImageBoxInstanceUid Method
See Also 
Leadtools.Dicom Namespace > DicomPrintScu Class : GetImageBoxInstanceUid Method



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.
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.
Returns the SOP Instance UID of the specified Basic Grayscale/Color Image Box SOP Instance.

Syntax

Visual Basic (Declaration) 
Public Function GetImageBoxInstanceUid( _
   ByVal index As Integer _
) As String
Visual Basic (Usage)Copy Code
Dim instance As DicomPrintScu
Dim index As Integer
Dim value As String
 
value = instance.GetImageBoxInstanceUid(index)
C# 
public string GetImageBoxInstanceUid( 
   int index
)
C++/CLI 
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).

Example

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.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

Leadtools.Dicom requires a Medical toolkit server license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features