GetAnnotationBoxesCount Method

Summary

Returns the number of the Basic Annotation Box SOP Instances created by the Print SCP when a Film Box is created.

Syntax

C++

public int GetAnnotationBoxesCount()

Public Function GetAnnotationBoxesCount() As Integer

public: 
int GetAnnotationBoxesCount();

Return Value

The number of the Annotation Boxes referenced by the current (last created) Film Box; if no Film Box is currently created, the method will return 0.

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 Value of 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 count of these Annotation Boxes.

Example

For an example, refer to Associate.

Requirements

Target Platforms