formZ SDK | 4.0 Call Back Reference | Object Type

# fz_otyp_cbak_name

Description

Object type name function (Required). This function is called whenever the name of the object type is needed. The objt and parm parameters may be passed as NULL. In this case a name for all objects of this type should be returned. If objt and parm are passed in, a particular object of this type exists, and the type name may be further specified based on the parameters of the object. For example, the sweep object type in formZ works this way. When its name function is called with NULL, it returns "Sweep". However, if it is called with a particular object as the parameter, the returned name contains which type of sweep it is, for example, "Axial Sweep", or "Two Source Sweep". Other object types do not make such a distinction and always return the same name, such as spheres, nurbz or symbols.

Plugin Prototype

fzrt_error_td fz_otyp_cbak_name(

fzrt_int | windex,
fz_objt_ptr | objt,
fzrt_ptr | parm,
char * | str,
fzrt_int | max_str )

Parameters

windex [Input]

project window index

objt [Input, Optional]

object

parm [Input, Optional]

generic pointer to the parameter block

str [Result]

the name of the object type

max_str [Input]

the maximum number of character which can be copied into the str argument.

Returns

Error codes

Availability

5.0.0.0

Function Set

fz_otyp_cbak_fset

Defined in

fz_otyp_api.h