SE_stable_get_shape

Returns a shape from an stable by feature id.

Usage syntax

LONG SE_stable_get_shape (SE_STABLE stable, LONG user_id, SE_SHAPE *shape_ptr, const void **associatedptr);

Parameters
stable The handle of the stable to search
user_id The user-defined ID of the shape to search for
shape_ptr A pointer to the location of the pointer to the found shape
associatedptr A pointer to the location of the pointer to the shape’s associated data
Description

SE_stable_get_shape finds a shape in the stable by feature id. If there is more than one shape in the stable with the same feature id, only the first shape found is returned. The pointer to the associated data is NULL if no associated data was inserted into the stable.

Returns

SE_SUCCESS
SE_ROW_NOEXIST

SE_INVALID_POINTER

Notes

•  This function executes on the client only.

•  An SE_ROW_NOEXIST error is returned if the feature id value is less than 0.

•  An SE_INVALID_POINTER error is returned if the stable handle or pointer to the shape is evaluated as NULL or if the stable handle references an invalid stable.

•  The returned shape is read-only and can’t be used for certain arguments of thirty-four shape functions. See 'Shape table functions' for a complete list.