In This Topic ▼

LBitmap::AddBorder

Summary

Adds a border to the class object's bitmap. The border is specified by the pAddBorderInfo parameter.

Syntax

#include "ltwrappr.h"

virtual L_INT LBitmap::AddBorder(pAddBorderInfo, uFlags = 0)

Parameters

pADDBORDERINFO pAddBorderInfo

Pointer to an ADDBORDERINFO structure that contains information about the border to add.

L_UINT32 uFlags

Reserved for future use. Must be 0.

Returns

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

Comments

To update a status bar or detect a user interrupt during execution of this function, refer to LBase::EnableStatusCallback.

This function does not support 12 and 16-bit grayscale and 48 and 64-bit color images. If the image is 12 and 16-bit grayscale and 48 and 64-bit color, the function will not return an error.

This function does not support signed data images. It returns the error code ERROR_SIGNED_DATA_NOT_SUPPORTED if a signed data image is passed to this function.

This function does not support 32-bit grayscale images. It returns the error code ERROR_GRAY32_UNSUPPORTED if a 32-bit grayscale image is passed to this function.

Required DLLs and Libraries

LTIMGEFX
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.

Example

L_INT LBitmap__AddBorderExample(LBitmap & Bitmap, L_TCHAR * pszFile) 
 
{ 
   L_INT nRet; 
   ADDBORDERINFO AddBorderInfo; 
    
   AddBorderInfo.uStructSize = sizeof(ADDBORDERINFO); 
   nRet =Bitmap.Load(pszFile); 
   if(nRet !=SUCCESS) 
      return nRet; 
 
   AddBorderInfo.nTopThickness = 20; 
   AddBorderInfo.nBottomThickness = 20; 
   AddBorderInfo.nLeftThickness = 20; 
   AddBorderInfo.nRightThickness = 20; 
   AddBorderInfo.crGradientStart = RGB(200, 150, 150); 
   AddBorderInfo.nLocation = BORDER_OUTSIDE; 
   AddBorderInfo.nStyle = BORDER_STYLE_OPAQUE; 
   AddBorderInfo.pTileBitmap=NULL; 
 
   nRet =Bitmap.AddBorder(&AddBorderInfo); 
   if(nRet !=SUCCESS) 
      return nRet; 
 
   return SUCCESS; 
}