SE_stream_get_spatial_masks

Returns the spatial filter masks for the current row

Usage syntax

LONG SE_stream_get_spatial_masks
(SE_STREAM stream,
LONG *masks);

Parameters
stream The stream handle
masks An array of spatial filter masks
Description

SE_stream_get_spatial_masks returns the spatial filter masks for the current row of the current query layer. There is one mask per spatial filter as specified in the call to SE_stream_set_spatial_constraints. If the calc_masks argument of SE_stream_set_spatial_constraints is TRUE, all spatial masks are retrieved. The spatial masks give the application the relationships between the current row’s shape and each of the spatial filters in the stream’s query. To get the full relationships between a filter and the current row’s feature, set calc_masks to TRUE for SE_stream_set_spatial_constraints.

If the calc_masks argument of SE_stream_set_spatial_constraints is set to FALSE, SE_stream_get_spatial_masks returns an SE_NO_SPATIAL_MASKS error.

You can call SE_stream_get_spatial_masks only after a call to SE_stream_fetch.

See SE_shape_find_relation for a list of possible spatial mask values.

Returns

SE_SUCCESS
SE_CONNECTION_IN_USE

SE_CONNECTION_LOCKED

SE_INVALID_POINTER

SE_INVALID_PARAM_VALUE

SE_FUNCTION_SEQUENCE_ERROR

SE_INVALID_STREAM_TYPE

SE_NO_SPATIAL_MASKS

SE_SDE_NOT_STARTED