formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Stair From Path
Description
Gets a parameter of a stair from path. Note, that when getting the path object ( which == FZ_OBJT_PATHSTAIR_PARM_PATH_OBJ), this function will create a new object in windex, and copy the content of the stairs path object into that new object. It is the responsibility of the calling function to delete this new object afterwards, using fz_objt_edit_delete_objt.
Plugin Prototype
fzrt_error_td fz_objt_edit_pathstair_parm_get(
fzrt_int | windex, |
obj, | |
which, | |
data ) |
Parameters
windex [Input]
project window index
obj [Input]
stair from path object
which [Input]
parameter identifier
data [Result]
parameter data
Returns
Error codes
MODEL_ERR_WRONG_OBJT_TYPE - object passed in is not a stair from path
Availability
5.0.0.0
Example Files
See Also
Function Set
Defined in