GetAnnotationBoxInstanceUid Method

Summary

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

Syntax

C++

public string GetAnnotationBoxInstanceUid( 
   int index 
)

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

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

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.

Requirements

Target Platforms