Navigation:  thinBasic Modules > TImage >

TImage_GetBitmapInfo

Previous pageReturn to chapter overviewNext page

 

Description

 

Returns and/or fill a TBITMAP UDT structure with info about a loaded image.

 

Syntax

 

sBitmap = TImage_GetBitmapInfo(ImageID [, ptrToTBITMAP])

 

Returns

 

String.

 

Parameters

 

Name

Type

Optional

Meaning

ImageID

Number

No

The unique ID used during TImage_Load.

ptrToTBITMAP

Number

Yes

A pointer to a TBITMAP udt structure that will receive image info.

If omitted, function will return a string representing a TBITMAP udt.

 

Remarks

 

If ptrToTBITMAP parameter is omitted or null, function will return a string that is the memory representation of a TBITMAP udt containing image info.

If ptrToTBITMAP parameter is present, function will return an empty string and passes TBITMAP pointed UDT will be filled instead.

 

Restrictions

 

See also

 

Examples