SE_stable_get_shape

Returns a shape from a shape (s) table 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 s table 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 s table by feature id. If there is more than one shape in the s table 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 s table.

The returned shape is read-only and cannot be used for certain arguments of thirty-four shape functions.

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 s table handle or pointer to the shape is evaluated as NULL or if the s table handle references an invalid s table.

Note: This function executes on the client only.

Returns

SE_SUCCESS
SE_ROW_NOEXIST

SE_INVALID_POINTER