L_DicomGetOverlayActivationLayer

#include "ltdic.h"

L_LTDIC_API L_UINT16 L_DicomGetOverlayActivationLayer(hDS, uOverlayIndex, pActivationLayer, uLength)

HDICOMDS hDS;

a DICOM handle

L_UINT uOverlayIndex;

the overlay index

L_TCHAR * pActivationLayer;

pointer to a buffer, which will be updated with the activation layer for the overlay

L_UINT uLength;

size of input buffer

Retrieves the "Overlay Activation Layer".

Parameter

Description

hDS

A DICOM handle.

uOverlayIndex

The index of the overlay for which to get the "Activation Layer". This index is zero-based.

pActivationLayer

Pointer to the buffer to be updated with the "Activation Layer" string. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

uLength

Specifies the maximum number of characters to copy to the buffer, including the NULL character. If the "Activation Layer" string exceeds this limit, it is truncated.

Returns

DICOM_SUCCESS

The function was successful.

>0

An error occurred. Refer to Return Codes.

Comments

This function copies the string which represents the "Overlay Activation Layer" (60xx,1001) into the buffer pointed to by pActivationLayer.

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, Linux.

Help Version 19.0.2017.10.18
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS DICOM C API Help