CImage:KwdGetStr

The KwdGetStr method returns the value of a string keyword in the image header. On failure, an empty string "" is returned. No test is performed to determine if the keyword actually exists. To test whether the keyword exists, call KwdExists before this method.To test whether the keyword exists, call KwdExists before this method.

Syntax

sValue = CImage:KwdGetStr( sKwd )

bullet.gif    sKwd is the keyword name.

bullet.gif    sValue is the returned value of sKwd .

bullet.gif    On success, the method returns the keyword value without enclosing ' ' characters.

bullet.gif    On failure, the method returns an empty string "".

Remarks

This method returns the value of a string type keyword. Alternatively, KwdGetStrEx returns 2 parameters: a boolean status code and the keyword value.

Example

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

f = I:KwdGetStr("FILTER")

-- read the keyword value

Printf( "Filter= '%s'",f)

-- print the value

Related Topics

CImage class

KwdGetStrEx

KwdGetRaw

KwdGetVal

KwdGetNum

KwdGetDMS

KwdGetHMS


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