This document is archived and information here might be outdated. Recommended version. |
Returns TRUE if the passed value is equal to the surface's void value.
[Visual Basic .NET]
Public Function IsVoidZ ( _
ByVal Value As Double _
) As Boolean
[C#]
public bool IsVoidZ (
double Value
);
[C++]
HRESULT IsVoidZ(
double Value
);
[C++] Parameters Value [in]
Value is a parameter of type double
Returns TRUE or FALSE depending on whether the specified Z is considered NODATA. Mathmatical operations cannot be performed on NODATA.
Some functions, such as ISurface.GetElevation, return a floating point number representing some characteristic of the surface for a given location. If the location does not fall within the interpolation zone some value representing NODATA must be returned. IsVoidZ can be used to evaluate if the result is NODATA.