CApphot:GetStatusCode


Returns the status code generated by the GetImageParams and Measure methods. If either of these methods encounters an error it sets the value of the nStatusCode class member which is accessed using this method. The codes are described in the documentation for each of these methods.

Syntax

nStatusCode = CApphot:GetStatusCode()

bullet.gif    nStatusCode is the status code that was set.

Remarks

The status code works differently for different methods:

bullet.gif    For the Measure method, the status code is 0 or a negative number corresponding to the error that occured.

bullet.gif    For GetImageParams, the status code is 0 or a positive number made from a bit-wise OR of error flags. The particular errors that occured can be decoded using the BitTest function. The error flags are listed under the GetImageParams topic.

Related Topics

CApphot class, CApphot Properties, GetErrMsg


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