LDicomDS::GetOverlayActivationLayer

Summary

Retrieves the "Overlay Activation Layer".

Syntax

#include "ltdic.h"

L_UINT16 LDicomDS::GetOverlayActivationLayer(uOverlayIndex,pActivationLayer,uLength)

Parameters

L_UINT uOverlayIndex

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

L_TCHAR * 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.

L_UINT 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

Value Meaning
0 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

Platforms

Win32, x64

See Also

Functions

Topics

Example

For an example, refer to LDicomDS::GetOverlayBitmapList.

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

LEADTOOLS DICOM C++ Class Library Help

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