GetAnnotationBoxInstanceUid Method

Returns the SOP Instance UID of the specified Basic Annotation Box SOP Instance.

Syntax

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

public string GetAnnotationBoxInstanceUid( 
   int index
)

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

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

public string GetAnnotationBoxInstanceUid( 
   int index
)

ObjectiveC Syntax

 function Leadtools.Dicom.DicomPrintScu.GetAnnotationBoxInstanceUid( 
   index 
)

public:
String^ GetAnnotationBoxInstanceUid( 
   int index
)

Parameters

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

Return Value

The SOP Instance UID of the specified Annotation 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, and if an Annotation Display Format ID is specified, the Print SCP will also create one or more Annotation Boxes, based on the Annotation Display Format ID. This will happen only if the Basic Annotation Box SOP Class is supported on the Association. This method returns the SOP Instance UID of a particular Annotation 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
GetAnnotationBoxesCount Method
UpdateAnnotationBox Method
FreeAnnotationBoxesInstanceUids Method
CreateFilmBox Method