L_GetOverlayAttributes

#include "l_bitmap.h"

L_LTKRN_API L_INT L_GetOverlayAttributes(pBitmap, nIndex, pOverlayAttributes, uStructSize, uFlags)

pBITMAPHANDLE pBitmap;

pointer to the main bitmap handle

L_INT nIndex;

the overlay index

pOVERLAYATTRIBUTES pOverlayAttributes;

pointer to the overlay attributes structure to be updated

L_UINT uStructSize;

the size of the OVERLAYATTRIBUTES structure pointed to by pOverlayAttributes

L_UINT uFlags;

flags that determine which attributes to retrieve

Gets one or more overlay attributes for the specified index.

Parameter Description
pBitmap Pointer to the bitmap handle referencing the main bitmap.
nIndex The index of the overlay for which to get the attributes. This index is zero-based.
pOverlayAttributes Pointer to the structure to be updated with the specified overlay attributes.
uStructSize Size of the OVERLAYATTRIBUTES structure pointed to by pOverlayAttributes. Pass sizeof(OVERLAYATTRIBUTES).
uFlags Flags that determine which attributes to retrieve. You can or these flags. Possible values are:
  Value Meaning
  OVERLAYATTRIBUTES_ORIGIN [0x0001] The top-left position should be retrieved. pOverlayAttributes ->ptOrigin will be updated with the top-left offset.
  OVERLAYATTRIBUTES_COLOR [0x0002] Indicates the color should be retrieved. pOverlayAttributes ->crColor will be updated with the color.
  OVERLAYATTRIBUTES_FLAGS [0x0004] Indicates the flags should be retrieved. pOverlayAttributes ->uFlags will be updated with the flags.
  OVERLAYATTRIBUTES_BITINDEX [0x0008] Indicates the corresponding bitplane position should be retrieved. pOverlayAttributes-> uBitPosition will be updated with the bitplane index.
  OVERLAYATTRIBUTES_DICOM [0x0010] Indicates that the DICOM-related attributes should be retrieved, this includes:
    pOverlayAttributes->uRows,
    pOverlayAttributes->uColumns,
    pOverlayAttributes->szType,
    pOverlayAttributes->uBitsAllocated,
    pOverlayAttributes->szDescription,
    pOverlayAttributes->szSubtype,
    pOverlayAttributes->szLabel,
    pOverlayAttributes->nROIArea,
    pOverlayAttributes->fROIMean,
    pOverlayAttributes->fROIStandardDeviation,
    pOverlayAttributes->nNumFramesInOverlay,
    pOverlayAttributes->uImageFrameOrigin,
    pOverlayAttributes->szActivationLayer

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The retrieved values will be stored in the structure pointed by pOverlayAttributes. pOverlayAttributes ->uStructSize will be set to the value of the parameter uStructSize. Only the uStructSize member of pOverlayAttributes and the values retrieved by the function will be updated. The other values are left unchanged.

Required DLLs and Libraries

LTKRN

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 20.0.2018.1.19
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C API Help