GetOverlayBoxInstanceUid Method

Returns the SOP Instance UID of the last created Basic Print Image Overlay Box SOP Instance.

Syntax

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

public string GetOverlayBoxInstanceUid()

'Declaration
 
Public Function GetOverlayBoxInstanceUid() As String

'Usage
 
Dim instance As DicomPrintScu
Dim value As String
 
value = instance.GetOverlayBoxInstanceUid()

public string GetOverlayBoxInstanceUid()

ObjectiveC Syntax

 function Leadtools.Dicom.DicomPrintScu.GetOverlayBoxInstanceUid()

public:
String^ GetOverlayBoxInstanceUid();

Return Value

The SOP Instance UID of the Image Overlay Box that was last created successfully using the method CreateOverlayBox.

Remarks

Once an Image Overlay Box is created, a call to this method will return the SOP Instance UID of the newly created Image Overlay Box. Therefore, if the SOP Instance UID of an Image Overlay Box is needed, it should be stored before creating the next Image Overlay 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
CreateOverlayBox Method
UpdateOverlayBox Method
DeleteOverlayBox Method
GetDefaultOverlayBoxParameters Method