L_DicomGetNextUnusedPrivateTag

Summary

Returns the next available unused tag reserved by the Private Creator Data Element. This feature is available in version 16 or higher.

Syntax

#include "Ltdic.h"

L_LTDIC_API L_UINT16 EXT_FUNCTION L_DicomGetNextUnusedPrivateTag(hDS, pPrivateCreatorDataElement, puTag)

Parameters

HDICOMDS hDS

A DICOM handle.

pDICOMELEMENT pPrivateCreatorDataElement

Pointer to the Private Creator Data Element.

L_UINT32 * puTag

Pointer to a variable that is updated with the next unused private tag.

Returns

Value Meaning
DICOM_SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

This function is used together with any of the following functions:

To create private elements in a DICOM data set. For more information on private elements, see L_DicomCreatePrivateCreatorDataElement function.

Use this function with an existing private creator data element to create private elements. If successful, argument *puTag will contain the next available unused tag that has been reserved by the private creator data element pointed to by argument pPrivateCreatorDataElement.

For example, suppose the following tags exist in a DICOM data set:

Tag Description
(0017, 0012) private creator data element
(0017, 1200) private element
(0017, 1201) private element
(0017, 1205) private element

After a successful call to the L_DicomGetNextUnusedPrivateTag function, *puTag will contains the value 0x00171202, which can be used with the L_DicomInsertElement function to add a new private element.

Required DLLs and Libraries

Platforms

Win32, x64, Linux.

See Also

Functions

Topics

Example

For an example, refer to L_DicomCreatePrivateCreatorDataElement.

Help Version 23.0.2024.7.1
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS DICOM C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.