CImage:KwdGetValEx

The KwdGetValEx method returns a success code and the value of a keyword in the image header. The keyword may be any type of value: string, number, date, time, etc.

Syntax

sValue, bSuccess = CImage:KwdGetValEx( sKwd )

where

sKwd is the keyword name.

sValue is the returned value of sKwd. On failure, nil is returned.

bSuccess is the returned success code. If the keyword exists, it is true.

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, KwdGetVal returns only 1 parameter, which is the keyword value.

Example

Suppose a CImage named I exists and contains keyword "FILTER", a string value, and "GAIN", a number value. The following script returns the value of FILTER and GAIN for the image I:

f, bSuccess = I:KwdGetValEx("FILTER")	-- gets the keyword if it exists
if ( bSuccess ) then	-- keyword exists
Printf( "FILTER= '%s'", f )	-- prints FILTER= 'Red'
end
g, bSuccess = I:KwdGetValEx("GAIN")	-- gets the keyword if it exists
if bSuccess then Printf("Gain=%s", g ) end	-- printf GAIN= 1.52