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 )

bullet.gif    sKwd is the keyword name.

bullet.gif    sValue is the returned value of sKwd .

bullet.gif    On success, bSuccess is true.

bullet.gif    On failure, bSuccess is false and sValue is nil.

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, 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, bOK = I:KwdGetStrEx("FILTER")

-- does the keyword exist?

if bOK then

-- keyword exists

  Printf( "FILTER= %s", f )

-- prints FILTER= Red

end

 

Related Topics

CImage class

KwdGetStr

KwdGetNumEx

KwdGetValEx


Mira Pro x64 Script User's Guide, Copyright Ⓒ 2023 Mirametrics, Inc. All Rights Reserved.