CImage:KwdGetNumEx

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 )

sKwd is the keyword to read.

nValue is the returned value of sKwd .

On success, bSuccess is true.

On failure, bSuccess is false and nValue is 0.

Remarks

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 fragment returns the value of DARKTIME for the image I:

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