formZ SDK | 5.0 API Reference | Project | Modeling | Attributes

fz_objt_attr_get_objt_snap

Description

Gets the snap status of an object. If display is TRUE, the snap status of the layer on which the object is placed is taken into account. Otherwise the true snap attribute of the object is returned.

Plugin Prototype

fzrt_error_td fz_objt_attr_get_objt_snap(

fzrt_int

windex,

fz_objt_ptr

obj,

fzrt_boolean

display,

fzrt_boolean *

snap )

Parameters

windex [Input]

project window index

obj [Input]

object

display [Input]

get from display context or attribute

snap [Result]

snap status

Returns

Error codes

Availability

5.0.0.0

Example Files

util_attr_basic.fsl

See Also

Function Set

fz_objt_attr_fset


Defined in

fz_objt_attr_api.h