SE_stable_add_shape

Adds a shape to a shape table

Usage syntax

LONG SE_stable_add_shape (SE_STABLE stable, SE_SHAPE shape, LONG user_id, const void *associated);

Parameters
stable The handle to a shape table
shape The shape to copy into the stable
user_id A user-defined ID for the shape
associated Optional associated data pointer
Description

SE_stable_add_shape adds a copy of a shape to an existing shape (s) table. You can also associate additional data with the shape. When you do, only a pointer to the data is stored in the stable, not the data itself. If the shape has CAD or annotation associated with it, it is copied to the shape table.

If the envelope of the shape extends beyond the extent of the s table as established by SE_stable_create , an SE_INVALID_ENVELOPE error is returned, and the shape is not added to the s table.

If the feature id of a shape is 0, an SE_INVALID_SHAPE error is returned, and the shape is not added to the s table.

If the pointer to the shape is evaluated as NULL, an SE_INVALID_POINTER error is returned, and the shape is not added to the s table.

If a new position in the stable cannot be allocated for the supplied shape, an SE_OUT_OF_CLMEM error is returned, and the shape is not added to the s table. This occurs when the available virtual memory is exhausted on the client machine.

Note: This function executes on the client only.

Returns

SE_SUCCESS
SE_INVALID_ENVELOPE

SE_INVALID_PARAM_VALUE

SE_INVALID_POINTER

SE_INVALID_SHAPE

SE_OUT_OF_CLMEM