formZ SDK | 5.0 API Reference | Project | Symbols

# fz_symb_def_get_comment

Description

Gets the comment string of a definition. Note : the comment parameter must be preallocated to at least 128 characters.

Plugin Prototype

fzrt_error_td fz_symb_def_get_comment(

fzrt_int | windex,
fz_symb_def_ptr | def_ptr,
char * | comment )

Parameters

windex [Input]

project window index

def_ptr [Input]

definition

comment [Result]

comment (must be preallocated to at least 128 characters)

Returns

Error codes

Availability

5.0.0.0

Example Files

util_symb_test.fsl

Function Set

fz_symb_fset

Defined in

fz_symb_api.h