CImage:KwdGetStrEx

The KwdGetStrEx method returns a success code and the value of a string keyword in the image header.

Syntax

sValue, bSuccess = CImage:KwdGetStrEx( 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, KwdGetStr returns only 1 parameter, which is the keyword value.

Example

Suppose a CImage named I exists and contains keyword "FILTER" with the value "Red". The following script returns the value of FILTER for the imageI:

f, bSuccess = I:KwdGetStrEx("FILTER")	-- does the keyword exist?
if bSuccess then	-- keyword exists
Printf( "FILTER= %s", f )	-- prints FILTER= Red
end