Sign in Join
FPDoc Onlineexperiment

FCL index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

NameKindUnitWhat it is
objvariableSyncObjs
ObjectCLasspropertyHTTPRouteObject class for handling requests
ObjectConstructorArgumentspropertyfpJsonToPasArguments for object constructors
ObjectFieldTypesconstantDB
ObjectFileNamepropertyfpMkUnitResolved object file name for the target
ObjectNamepropertySQLTypesName of the object in the database.
ObjectPathpropertyfpMkUnitSearch paths for object files
ObjectPathpropertyfpMkUnitPath for object files generated during compilation
ObjectspropertyfpJsonGet or set elements as JSON object values.
ObjectspropertyfpJsonNamed access to JSON object values.
ObjectToViewprocedurefpObserverCopies data from subject object to view component
ObjectToViewprocedurefpObserver
ObjectTypepropertyDB
ObjExtconstantfpMkUnitObject file extension
ObservedChangedprocedurefpObserverHandles changes in the observed list objects
ODSMajorVersionvariableIBConnectionDatabase On-Disk Structure major version.
ODSMajorVersionpropertyIBConnectionDatabase On-Disk Structure major version.
OffvariableBufDatasetOffset to data in the record buffer.
OffsetpropertyDBOffset of the field's value in the dataset buffer.
offsetvariableGetTextOffset in the file.
OldValuepropertyDBOld value of the field.
OldValuesBuffervariableBufDatasetBuffer for pre-editing values for the record.
OnActionpropertyfpMkUnitAction type that triggers this notification event
OnArchiveFilesvariablefpMkUnitGlobal archive event handler
OnBeforeSetupFieldpropertyfpObserverEvent for formatting field values in all item mediators
OnBeforeSetupFieldpropertyfpObserverEvent for formatting field values before display
OnBooleanValuepropertyJsonReaderEvent fired when a JSON boolean value is encountered
OnCalcFieldspropertyBufDatasetEvent triggered when values for calculated fields must be computed.
OnCalcFieldspropertyDBEvent triggered when values for calculated fields must be computed.
OnCalcFieldspropertySQLDB
OnCalcFieldspropertySQLDBEvent triggered when values for calculated fields must be computed.
OnChangepropertyDBEvent triggered when the field's value has changed.
OnChangepropertyDB
OnChangeSQLprocedureSQLDB
OnCloseErrorpropertyDB
OnCloseInputStreampropertyZipperEvent handler signalled when the input stream for the .ZIP file is closed.
OnComparepropertyAVL_TreeCompare function used when comparing nodes.
OnContinuepropertyDaemonAppDaemon continue.
OnControlCodepropertyDaemonAppCalled when a control code is received for the daemon.
OnControlCodeEventpropertyDaemonApp
OnCreatepropertyDaemonAppEvent called when the daemon mapper is created.
OnCreateInstancepropertyDaemonAppEvent called when a daemon in instantiated.
OnCreateStreampropertyZipperEvent handler signalled when an output stream is created.
OnDataChangepropertyDBCalled whenever data changes in the current record.
OnDataReceivedpropertyfpHTTPClient
OnDataReceivedpropertyfpHTTPClientEvent called during data reception to track progress
OnDataSentpropertyfpHTTPClient
OnDataSentpropertyfpHTTPClientEvent called during data transmission to track progress
OnDeleteErrorpropertyBufDatasetEvent triggered when a delete operation fails.
OnDeleteErrorpropertyDBEvent triggered when a delete operation fails.
OnDeleteErrorpropertyMemDsEvent triggered when a delete operation fails.
OnDeleteErrorpropertySQLDB
OnDeleteErrorpropertySQLDBEvent triggered when a delete operation fails.
OnDestroypropertyDaemonAppEvent called when the daemon mapper is freed.
OnDirectivepropertySQLDBEvent handler if a directive is encountered.
OnDoneStreampropertyZipperEvent handler signalled when an output stream is closed.
OnEditErrorpropertyBufDatasetEvent triggered when an edit operation fails.
OnEditErrorpropertyDBEvent triggered when an edit operation fails.
OnEditErrorpropertyMemDs
OnEditErrorpropertySQLDB
OnEditErrorpropertySQLDBEvent triggered when an edit operation fails.
OnEndArraypropertyJsonReaderEvent fired when a JSON array ends
OnEndFilepropertyZipperCallback procedure that will be called after unzipping a file.
OnEndFilepropertyZipperEvent handler signalled when compression for a file has been completed.
OnEndObjectpropertyJsonReaderEvent fired when a JSON object ends
OnEraseSectionpropertyRttiUtilsErase a section in storage.
OnEventpropertyfpMkUnitStandard notify event callback procedure
OnEventStreampropertyfpHTTPClient
OnEventStreampropertyfpHTTPClientEvent called when a Server-Sent Events stream is established
OnExceptionpropertyCustAppException handling event.
OnExceptionpropertySQLDBException handling event.
OnExecutepropertyDaemonAppDaemon execute event.
OnFilterRecordpropertyBufDatasetEvent triggered to filter records.
OnFilterRecordpropertyDBEvent triggered to filter records.
OnFilterRecordpropertyMemDsEvent handler signalled to include or exclude records in the in-memory dataset.
OnFilterRecordpropertySQLDB
OnFilterRecordpropertySQLDBEvent triggered to filter records.
OnFloatValuepropertyJsonReaderEvent fired when a JSON floating-point value is encountered
OnForkEventpropertyProcessEvent triggered after fork occurred on Linux.
OnFreeSlotpropertyCacheClsEvent called when a slot is freed.
OnGetActionpropertyfpHTTPEvent for action name determination
OnGetActionpropertyFpWebEvent called to determine which action to execute
OnGetActionpropertyFpWebEvent called to determine which action to execute
OnGetCustomCategorypropertyEventLogEvent to retrieve custom message category.
OnGetCustomEventpropertyEventLogEvent to retrieve custom event Code.
OnGetCustomEventIDpropertyEventLogEvent to retrieve custom event ID.
OnGetFunctionValuepropertyfpExprParsEvent for function value evaluation
OnGetFunctionValueCallBackpropertyfpExprParsCallback property for function value evaluation
OnGetHandlepropertyProcess
OnGetModulepropertyCustWebEvent for custom module selection logic
OnGetModulepropertyCustWebEvent for custom module selection logic
OnGetParampropertyfpTemplateEvent to get a value for a template variable.
OnGetParampropertyfpTemplateEvent to get a value for a template variable.
OnGetParampropertyfpTemplateEvent to get a value for a template variable.
OnGetParampropertyFpWebEvent called to resolve template parameters
OnGetSocketHandlerpropertyfpHTTPClient
OnGetSocketHandlerpropertyfpHTTPClientEvent called to provide custom socket handlers
OnGetTextpropertyDBEvent to format the field's content.
OnGetVariableValuepropertyfpExprParsEvent for variable value evaluation
OnGetVariableValueCallBackpropertyfpExprParsCallback property for variable value evaluation
OnHeaderspropertyfpHTTPClient
OnHeaderspropertyfpHTTPClientEvent called when response headers are received
OnIdlepropertyCustWebEvent triggered when the handler is idle between requests
OnInitModulepropertyCustWebEvent for initializing HTTP modules before request processing
OnInstallpropertyDaemonAppEvent called when the daemons are installed.
OnInt64ValuepropertyJsonReaderEvent fired when a JSON 64-bit integer value is encountered
OnIntegerValuepropertyJsonReaderEvent fired when a JSON integer value is encountered
OnIsDataEqualpropertyCacheClsEvent to compare 2 items.
OnKeyNamepropertyJsonReaderEvent fired when a JSON object key name is encountered
OnLogpropertyCustWebEvent for logging web application events and errors
OnLogpropertyfpMkUnitEvent handler for logging messages
OnLogpropertyPasCodeGenEvent handler for log messages
OnLogpropertySQLDBEvent handler for logging events.
OnLoginpropertyDBEvent triggered when a login prompt is shown.
OnLoginpropertyIBConnectionEvent triggered when a login prompt needs to be shown.
OnLoginpropertyMSSQLConnCalled when logging in.
OnLoginpropertySQLDBEvent handler for login process.
OnLogMessagepropertyEventLogImplement custom handling of log messages.
OnMasterChangepropertyDBCalled whenever the master dataset data changes.
OnMasterDisablepropertyDBCalled whenever the master dataset is disabled.
OnMessagepropertySimpleIPCEvent triggered when a message arrives.
OnMessageErrorpropertySimpleIPCEvent called when a new message has arrived, and the queue is full.
OnMessageQueuedpropertySimpleIPCEvent called when a new message has arrived.
OnModuleRequestpropertyfpHTTPEvent for module request handling
OnNewRecordpropertyBufDatasetEvent triggered when a new record is created.
OnNewRecordpropertyDBEvent triggered when a new record is created.
OnNewRecordpropertyMemDsEvent triggered when a new record is created.
OnNewRecordpropertySQLDB
OnNewRecordpropertySQLDBEvent triggered when a new record is created.
OnNewSessionpropertyfpHTTPEvent triggered when a new session is created
OnNewSessionpropertyFpWebEvent called when a new session is created
OnNullValuepropertyJsonReaderEvent fired when a JSON null value is encountered
OnNumberValuepropertyJsonReaderEvent fired when a JSON number value is encountered
OnObjectComparepropertyAVL_TreeCompare handler.
OnObjectToViewpropertyfpObserverEvent triggered when copying data from subject to view
OnOpenInputStreampropertyZipperEvent handler signalled when the input stream for the .ZIP file is opened.
OnPasswordpropertyfpHTTPClient
OnPasswordpropertyfpHTTPClientEvent called when authentication is required
OnPausepropertyDaemonAppDaemon pause event.
OnPercentpropertyZipperThreshold percentage which triggers an OnProgress update.
OnPercentpropertyZipperPercentage of decompression completion.
OnPercentpropertyZipperThreshold percentage which triggers a progress notification.
OnPercentpropertyZipperThreshold percentage which triggers progress notifications when processing files.
OnPostErrorpropertyBufDatasetEvent triggered when a post operation fails.
OnPostErrorpropertyDBEvent triggered when a post operation fails.
OnPostErrorpropertyMemDsEvent triggered when a post operation fails.
OnPostErrorpropertySQLDB
OnPostErrorpropertySQLDBEvent triggered when a post operation fails.
OnProcEventpropertyfpMkUnitProcedural notify event callback
OnProgresspropertyZipperEvent handler signalled to indicate the completion percentage for the compressor.
OnProgresspropertyZipperEvent handler for OnProgress procedure.
OnProgresspropertyZipperProgress event handler used when decompressing files.
OnProgresspropertyZipperEvent handler signalled to show a percent complete progress notifications.
OnProgresspropertyZStreamProgress handler.
onprogresspropertyZStream
OnProgresspropertyZStreamProgress handler.
OnProgressExpropertyZipperEvent handler signalled to indicate progress using processed and total byte counts.
OnProgressExpropertyZipperExtended progress event handler used when decompressing files.
OnQWordValuepropertyJsonReaderEvent fired when a JSON quadword value is encountered
OnReadStringpropertyRttiUtilsRead a string value from storage.
OnRedirectpropertyfpHTTPClient
OnRedirectpropertyfpHTTPClientEvent called when a redirect is encountered
OnReplaceTagpropertyfpTemplateEvent to replace a tag.
OnReplaceTagpropertyfpTemplateEvent to replace a tag.
OnReplaceTagpropertyfpTemplateEvent to replace a tag.
OnRequestpropertyFpWebEvent called for request processing
OnRequestpropertyFpWebEvent handler called when this action is executed
OnRequestpropertyFpWebEvent called for request processing
OnRunpropertyDaemonAppEvent executed when the daemon is run.
OnRunpropertyDaemonAppEvent called when the daemons are executed.
OnRunCommandEventpropertyProcessEvent handler, called when RunCommandLoop is executing.
OnServerReceivedCustomRequestpropertyAdvancedSingleInstanceServer event triggered when a custom request is received.
OnServerReceivedParamspropertySingleInstanceEvent triggered during ServerCheckMessages.
OnSessionExpiredpropertyfpHTTPEvent triggered when a session expires
OnSessionExpiredpropertyFpWebEvent called when a session expires
OnSessionStateChangepropertyHTTPDefsEvent triggered when session state changes
OnSetTextpropertyDBEvent to set the field's content based on a user-formatted string.
OnShowRequestExceptionpropertyCustWebEvent for custom exception handling during request processing
OnShowRequestExceptionpropertyCustWebEvent for custom exception handling during request processing
OnShutDownpropertyDaemonAppDaemon shutdown.
OnSQLChangedpropertySQLDB
OnStartpropertyDaemonAppDaemon start event.
OnStartArraypropertyJsonReaderEvent fired when a JSON array begins
OnStartFilepropertyZipperCallback procedure that will be called before unzipping a file.
OnStartFilepropertyZipperEvent handler signalled when compression for a file is started.
OnStartObjectpropertyJsonReaderEvent fired when a JSON object begins
OnStartTimerpropertyfpTimerEvent handler signalled when the timer is started.
OnStartTimerpropertyfpTimerEvent handler signalled when the timer is started.
OnStateChangepropertyDBCalled whenever the state of the dataset changes.
OnStoppropertyDaemonAppDaemon stop event.
OnStopTimerpropertyfpTimerEvent handler signalled when the timer is stopped.
OnStopTimerpropertyfpTimerEvent handler signalled when the timer is stopped.
OnStreamEncodingEventpropertyHTTPDefsEvent handler for stream encoding processing
OnStringValuepropertyJsonReaderEvent fired when a JSON string value is encountered
OnTemplateContentpropertyFpWebEvent called for template content processing
OnThreadErrorpropertySimpleIPCTriggered when a thread reports an error.
OnTimerpropertyfpTimerEvent handler signalled when the Interval for the timer has elapsed.
OnTimerpropertyfpTimerEvent called on each timer tick.
OnTranslationErrorvariableGetText
OnUnInstallpropertyDaemonAppEvent called when the daemons are uninstalled.
OnUnknownEncodingpropertyHTTPDefsEvent handler for unknown content encoding
OnUnknownRequestEncodingpropertyCustWebEvent for handling unknown request content encodings
OnUnknownRequestEncodingpropertyCustWebEvent for handling unknown request content encodings
OnUpdateDatapropertyDBCalled whenever the data in the dataset must be updated.
OnUpdateErrorpropertyBufDatasetEvent handler signalled when an error occurs while updating records.
OnValidatepropertyDBEvent to validate the value of a field before it is written to the data buffer.
OnVerifySSLCertificatepropertyfpHTTPClient
OnVerifySSLCertificatepropertyfpHTTPClientEvent called for custom SSL certificate verification
OnViewToObjectpropertyfpObserverEvent triggered when copying data from view to subject
OnWriteStringpropertyRttiUtilsWrite a string value to storage.
OpenprocedureDBMakes the connection to the server.
OpenprocedureDBActivate the dataset: Fetch data into memory.
OpenCursorprocedureDB
OpenCursorprocedureSQLDB
OpenCursorcompleteprocedureDB
OpenInputprocedureZipper
OpenInputfunctionZipper
OpenOutputfunctionZipper
OpenTransprocedureDB
OperandpropertyfpExprParsThe operand expression of the unary operator
OptionCharpropertyCustAppCommand-line switch character.
OptionsvariableBufDatasetOptions for the index.
OptionsvariableBufDatasetLocate options used in the comparison.
OptionspropertyDaemonAppService options.
OptionspropertyDBIndex options.
OptionsprocedurefpHTTPClientPerforms an HTTP OPTIONS request
OptionsvariablefpJson
OptionspropertyfpJsonToPasCode generation options
OptionspropertyfpMkUnitCommand line options
OptionspropertyfpMkUnitConfiguration options for the build
OptionspropertyfpMkUnitCompiler options for the package
OptionspropertyfpMkUnitCompiler options for this variant
OptionspropertyfpMkUnitCompiler options for the target
OptionspropertyHTTPDefsCORS configuration options
OptionspropertyIniFilesOptions currently in effect.
OptionspropertyJsonReaderJSON parsing options that control reader behavior
OptionspropertyJsonScannerScanner options set
OptionspropertyProcessOptions to be used when starting the process.
OptionspropertyRttiUtilsOptions to take into account when saving or loading properties from the storage.
OptionspropertySQLDB
OptionspropertySQLDBOptions to observe for this connection.
OptionspropertySQLDBOptions controlling the behaviour of the dataset.
OptionspropertySQLDBTransaction options.
OrderCurrentRecordprocedureBufDataset
OrderCurrentRecordprocedureBufDataset
OrderCurrentRecordprocedureBufDataset
OrgBufIDvariableBufDatasetIdentifies the original blob buffer for an update buffer.
OriginpropertyDBOriginal fieldname of the field.
Original_SizevariableZipperUnompressed file size.
OriginalExceptionpropertyDBOriginally raised exception.
OrigStringsvariableGetText
OrigTablevariableGetText
OrigTabOffsetvariableGetTextOffset of the original strings description table.
OSvariablefpMkUnitTarget operating system
OSpropertyfpMkUnitTarget operating system
OSpropertyZipperIndication of operating system/file system.
OS_FATconstantZipperMS-DOS and OS/2 (FAT/VFAT/FAT32).
OS_NTFSconstantZipperNTFS.
OS_OS2constantZipperOS/2 HPFS.
OS_OSXconstantZipperMac OSX.
OS_UNIXconstantZipperUNIX-like platforms.
OS_VFATconstantZipperVFAT.
OSCPUSupportedconstantfpMkUnitMatrix of supported OS/CPU combinations
OSespropertyfpMkUnitOperating systems for which this string applies
OSespropertyfpMkUnitSupported operating systems for the package
OSespropertyfpMkUnitSet of operating systems this target supports
OSesToStringfunctionfpMkUnitConverts set of operating systems to string
OSToStringfunctionfpMkUnitConverts operating system identifier to string
OurHandlepropertyProcess
OutputpropertyProcessStream connected to standard output of the process.
OutputDescriptorpropertyProcess
OutputErrorprocedureEzCgi
OutputPathpropertyZipperPath where archive files will be unzipped.
OutputUnitNamepropertyPasCodeGenName of the output unit
OwnerpropertySimpleIPCTSimpleIPCClient instance for which communication must be handled.
OwnerpropertySimpleIPCTSimpleIPCServer instance for which to handle transport.
OwnerListpropertyContnrs
OwnerProcesspropertyProcess
OwnsEncodingpropertyIniFilesDoes the ini file instance own the encoding ?
OwnsJSONpropertyfpJsonApplySet specifying which JSON objects are owned by the component
OwnsObjectspropertyContnrsDoes the list own the objects it contains.
OwnsObjectspropertyContnrsDoes the hash table own the objects ?
OwnsObjectspropertyContnrsShould the list free elements when they are removed.
OwnsObjectspropertyContnrsShould the list free elements when they are removed.
OwnsStreampropertySimpleIPCDoes the message own the stream.
OwnsStreampropertyStreamExShould the stream be freed on close.
OwnStreamprocedureStreamEx

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.