LDicomDS::GetOverlayActivationLayer
#include "ltdic.h"
L_UINT16 LDicomDS::GetOverlayActivationLayer( uOverlayIndex, pActivationLayer, uLength)
L_UINT uOverlayIndex; |
/* index */ |
L_CHAR * pActivationLayer; |
/* pointer to a buffer */ |
L_UINT uLength; |
/* size of the input buffer */ |
Retrieves the "Overlay Activation Layer".
Parameter |
Description |
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
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
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 |
See Also
Example
For an example, refer to LDicomDS::GetOverlayBitmapList.