Collapse All Expand All

LDicomPrintSCU::GetAnnotationBoxInstanceUID

#include "ltdic.h"

L_PCTSTR LDicomPrintSCU::GetAnnotationBoxInstanceUID(uIndex) const

L_UINT32 uIndex;

/* index of the Annotation Box */

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

Parameter	Description
uIndex	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 function LDicomPrintSCU::GetAnnotationBoxesCount returns the count of Annotation Boxes.

Returns

The SOP Instance UID of the specified Annotation Box. If an invalid index is passed, the function will return NULL.

Comments

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 function returns the SOP Instance UID of a particular Annotation Box.

Required DLLs and Libraries

LTDIC For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application

Platforms

Win32, x64

See Also

Functions:	Class Members, LDicomPrintSCU::GetAnnotationBoxesCount, LDicomPrintSCU::UpdateAnnotationBox, LDicomPrintSCU::FreeAnnotationBoxesInstanceUIDs, LDicomPrintSCU::CreateFilmBox
Topics:	Print Management SCU
	DICOM Print Management Service Class User: Functions

Example

For an example, refer to LDicomPrintSCU::UpdateImageBox.