CImage:KwdGetNumEx

The KwdGetNumEx method returns a success code and the value of a numeric keyword in the image header.

Syntax

nValue, bSuccess = CImage:KwdGetNumEx( sKwd )

where

sKwd is the keyword to read.

nValue is the returned value of sKwd.

bSuccess is the returned success code. If the keyword exists, it is true. On failure, 0, false is returned.

This method returns a boolean success code that tells if the keyword exists in the image header. If true, then the keyword value is also returned. Alternatively, KwdGetNum returns only 1 parameter, which is the keyword value.

Example

Suppose a CImage named I exists and contains keyword "DARKTIME". The following script returns the value of DARKTIME for the image I:

t, bSuccess = I:KwdGetNumEx("DARKTIME")	-- does the keyword exist?
if ( bSuccess ) then	-- keyword exists
Printf( "Darktime= %lg sec", t )	-- print the value
end