GetImageBoxInstanceUid Method

Summary

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

Syntax

C++

public string GetImageBoxInstanceUid( 
   int index 
)

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

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 VB).

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.

Requirements

Target Platforms