| Click here to show toolbars of the Web Online Help System: show toolbars |
| |
CImage:KwdGetStrEx
The KwdGetStrEx method returns a success code and the value of a string keyword in the image header.
|
sValue, bSuccess = CImage:KwdGetStrEx( sKwd ) |
sKwd is the keyword name.
sValue is the returned value of sKwd .
On success,
bSuccess is true.
On failure,
bSuccess is false and sValue is
nil.
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.
Suppose a CImage named I exists and contains keyword "FILTER" with the value "Red". The following script fragment returns the value of FILTER for the image I:
|
f, bOK = I:KwdGetStrEx("FILTER") |
-- does the keyword exist? |
|
if bOK then |
-- keyword exists |
|
Printf( "FILTER= %s", f ) |
-- prints FILTER= Red |
|
end |
|