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
RaiseErrorprocedureMemDsRaises an exception for an invalid operation in the in-memory dataset.
RaiseExceptionOnErrorpropertyEventLogDetermines whether logging errors are reported or ignored.
RaiseExceptionOnSendErrorvariableDbugIntf
RaiseMediatorErrorprocedurefpObserver
RangeErrorprocedureDB
raw_readvariableZStream
raw_writtenvariableZStream
RawDatapropertyHTTPDefsRaw unprocessed MIME item data
ReadfunctionAscii85Read data from stream.
ReadfunctionAscii85Read data from the internal buffer.
ReadfunctionBase64Read and decrypt data from the source stream.
ReadfunctionBlowFishRead data from the stream.
ReadfunctionBufDatasetReads the specified number of bytes from the stream into the given buffer.
ReadfunctionBufStreamReads the specified number of bytes into the Buffer parameter.
ReadfunctionBufStreamReads data from the stream.
ReadfunctionIdeaReads data from the stream, decrypting it as needed.
ReadfunctionIoStreamRead data from the stream.
ReadfunctionNullStreamRead null bytes from the stream.
ReadfunctionPipesRead data from the stream to a buffer.
ReadfunctionPipesRead data from the stream.
ReadprocedureStreamExRead data from stream.
ReadfunctionStreamExRead data from the stream.
ReadfunctionSyncObjs
readfunctionZStreamRead data from the compressed stream.
readfunctionZStreamRead data from the compressed file.
ReadfunctionZStream
READ_PERMISSIONSconstantLibTarSet with all read permissions.
ReadBase64ByteCountvariableBase64
ReadBinaryStreamfunctionIniFilesRead binary data.
ReadBoolfunctionIniFiles
ReadBoolfunctionJsonIniReads a boolean value from the JSON ini file
ReadBooleanfunctionStreamColl
ReadBooleanfunctionStreamColl
ReadBufLenconstantfpHTTPClientDefault buffer size for socket reading operations
ReadContentprocedureHTTPDefs
ReadCurrencyfunctionStreamColl
ReadCurrencyfunctionStreamColl
ReadDatefunctionIniFilesRead a date value.
ReadDatefunctionJsonIniReads a date value from the JSON ini file
ReadDateTimefunctionIniFilesRead a Date/Time value.
ReadDateTimefunctionJsonIniReads a date-time value from the JSON ini file
ReadDateTimefunctionStreamColl
ReadDateTimefunctionStreamColl
ReadDebugMessageFromStreamprocedureDbugMsgRead a message from stream.
ReadDoublefunctionStreamExRead a double-precision floating point value from the stream.
ReadDWordBEfunctionStreamExRead a DWord from the stream, big endian.
ReadDWordLEfunctionStreamExRead a DWord from the stream, little endian.
ReadEventfunctionfpHTTPClientReads one Server-Sent Event from the stream
ReadFieldDefsFromStreamprocedureMemDsReads field definitions from the specified stream.
ReadFileprocedureLibTarRead a file from the archive.
ReadFileInfoprocedureFileInfoReads version information from the specified file
ReadFloatfunctionIniFilesRead a floating point value.
ReadFloatfunctionJsonIniReads a floating-point value from the JSON ini file
ReadFloatfunctionStreamColl
ReadFloatfunctionStreamColl
ReadFromSocketfunctionfpHTTPClient
ReadFromSocketfunctionfpHTTPClient
ReadIniValuesprocedureIniFiles
ReadInputStreamfunctionProcessRead available data from input stream.
ReadInt64functionIniFilesRead an Int64 value.
ReadInt64functionJsonIniReads a 64-bit integer value from the JSON ini file
ReadIntegerfunctionIniFilesRead an integer value from the file.
ReadIntegerfunctionJsonIniReads an integer value from the JSON ini file
ReadIntegerfunctionStreamColl
ReadIntegerfunctionStreamColl
ReadLineprocedureStreamExRead a line of text.
ReadLineprocedureStreamExRead a line of text.
ReadLineprocedureStreamExRead a line of text.
ReadLineprocedureStreamExRead a line of text.
ReadMessageprocedureSimpleIPCRead message from the channel.
ReadMessagefunctionSimpleIPCRead message from the queue.
ReadOnlypropertyBufDataset
ReadOnlypropertyBufDatasetIndicates if records can be added, deleted, or modified in the dataset.
ReadOnlypropertyDBIs the link readonly.
ReadOnlypropertyDBIs the field read-only.
ReadOnlypropertyfpObserverPrevents data transfer from view to subject when True
ReadOnlypropertySQLDB
ReadQWordBEfunctionStreamExRead a QWord from the stream, big endian.
ReadQWordLEfunctionStreamExRead a QWord from the stream, little endian.
ReadRequestfunctionAdvancedIPCRead a previously peeked request
ReadResponsefunctionfpHTTPClient
ReadResponseHeadersfunctionfpHTTPClient
ReadSectionprocedureIniFilesRead the key names in a section.
ReadSectionprocedureIniFilesRead the key names in a section.
ReadSectionprocedureJsonIniReads all key names from a section
ReadSectionRawprocedureIniFilesRead raw section.
ReadSectionsprocedureIniFilesRead the list of sections.
ReadSectionsprocedureIniFilesRead section names.
ReadSectionsprocedureJsonIniReads all section names from the JSON ini file
ReadSectionValuesprocedureIniFilesRead names and values of a section.
ReadSectionValuesprocedureIniFiles
ReadSectionValuesprocedureJsonIniReads all key-value pairs from a section
ReadSinglefunctionStreamExRead a single-precision floating point value from the stream.
ReadStateprocedureDB
ReadStrfunctionStreamExOverrides the standard ReadStr method.
ReadStringfunctionfpHTTPClient
ReadStringfunctionfpHTTPClient
ReadStringfunctionIniFilesRead a string valued key.
ReadStringfunctionIniFilesRead a string.
ReadStringfunctionJsonIniReads a string value from the JSON ini file
ReadStringfunctionRttiUtils
ReadStringfunctionStreamColl
ReadStringfunctionStreamColl
ReadTimefunctionIniFilesRead a time value.
ReadTimefunctionJsonIniReads a time value from the JSON ini file
ReadWordBEfunctionStreamExRead a Word from the stream, big endian.
ReadWordLEfunctionStreamExRead a Word from the stream, little endian.
ReadyToCompilefunctionfpMkUnitChecks if package is ready for compilation
ReadZipDirectoryprocedureZipper
ReadZipHeaderprocedureZipper
RecalcBufListSizeprocedureDB
RecalcTargetprocedurefpMkUnit
RecNopropertyBufDatasetActive record number in the index.
RecNopropertyDBCurrent record number.
RecognizeStreamfunctionBufDataset
RecognizeStreamfunctionBufDataset
ReconnectToServerprocedurefpHTTPClient
Record_SizevariableZipperThis record size.
RecordChangedprocedureDB
RecordChangedprocedureDB
RecordCountpropertyDBNumber of records in the buffer of the dataset.
RecordCountpropertyDBNumber of records in the dataset.
RecordSizepropertyDBSize of the record in memory.
RecursivepropertyfpTemplateEnable recursive parsing.
RedirectForcesGETfunctionfpHTTPClientChecks if a redirect status code forces GET method
RedirectOnErrorpropertyCustWebControls whether errors trigger HTTP redirects
RedirectOnErrorpropertyCustWebControls whether errors trigger HTTP redirects
RedirectOnErrorURLpropertyCustWebURL template for error redirects
RedirectOnErrorURLpropertyCustWebURL template for error redirects
RefererpropertyHTTPDefsReferer header field value
RefreshprocedureDBRefresh the records in the dataset.
RefreshingpropertyBufDatasetIndicates if the Refresh method has been called but has not completed.
RefreshInternalCalcFieldsprocedureDB
RefreshLastInsertIDfunctionMSSQLConn
RefreshLastInsertIDfunctionSQLDB
RefreshLastInsertIDfunctionSQLDB
RefreshLastInsertIDfunctionSQLDB
RefreshLookupListprocedureDBRefresh the lookup list.
RefreshParamNamesprocedureDBRefresh the list of parameter names.
RefreshRecordfunctionSQLDB
RefreshSQLpropertySQLDB
RefreshSQLpropertySQLDBRefresh query to re-fetch field values after a DB update.
RegenerateSessionIDprocedureHTTPDefs
RegisterConnectionprocedureSQLDBRegister a new connection type for use in the universal connector.
RegisterDaemonApplicationClassprocedureDaemonAppRegister alternative TCustomDaemonApplication class.
RegisterDaemonClassprocedureDaemonAppRegister daemon.
RegisterDaemonMapperprocedureDaemonAppRegister a daemon mapper class.
RegisterDatapacketReaderprocedureBufDatasetRegisters a data packet reader using a specific format for TBufDataset.
RegisterDatasetprocedureDB
RegisterHTTPModuleprocedurefpHTTPRegisters an HTTP module with the factory
RegisterHTTPModuleprocedurefpHTTPRegisters an HTTP module
RegisterInterceptorprocedureHTTPRouteRegisters a request interceptor
RegisterMediatorfunctionfpObserverRegisters a new mediator class with the manager
RegisterMessageFilefunctionEventLogRegister message file.
RegisterModuleprocedurefpHTTPRegisters the module with the factory
RegisterPluginprocedurefpMkUnitRegisters plugin with the manager
RegisterRoutefunctionHTTPRouteRegisters a new route with the router
RegisterStatementprocedureSQLDB
RegisterStdBuiltinsprocedurefpExprParsRegister standard built-in functions
Relative_Hdr_OffsetvariableZipperOffset to the local header record.
ReleaseprocedureSyncObjsLeave the critical section.
ReleaseprocedureSyncObjs
ReleaseprocedureSyncObjs
ReleaseprocedureSyncObjsRelease previously acquired synchronization resource.
ReleaseSpareRecordprocedureBufDataset
ReleaseSpareRecordprocedureBufDatasetReleases resources allocated to the spare record for the index.
ReleaseSpareRecordprocedureBufDatasetReleases the spare record in the index.
ReleaseSpareRecordprocedureBufDataset
RemoteAddrpropertyHTTPDefsAlias for RemoteAddress property
RemoteAddresspropertyHTTPDefsREMOTE_ADDR environment variable value
RemoteHostpropertyHTTPDefsREMOTE_HOST environment variable value
RemovefunctionAVL_TreeRemove a data item from the list.
RemoveprocedureCacheClsRemove a data item from the list.
RemovefunctionContnrsRemove a class pointer from the list.
RemovefunctionContnrsRemove a component from the list, possibly destroying it.
RemovefunctionContnrsRemove an item from the list.
RemovefunctionContnrsRemove first instance of a pointer.
RemovefunctionContnrsRemove first occurrence of a object instance.
RemovefunctionContnrsRemove an item from the list.
RemovefunctionContnrsRemove an object from the list.
RemovefunctionContnrsRemove (and possibly free) an element from the list.
RemoveprocedureDBRemove an instance from the list.
RemovefunctionfpExprPars
RemoveprocedurefpJsonRemove an element from the list.
RemoveprocedurefpJsonRemove item by instance.
RemovepropertyfpMkUnitFile removal command and options
RemoveprocedureIniFilesRemove a key from the hash.
RemoveCellprocedureCsvDocumentRemove a cell at a particular row.
RemoveControllerprocedureDaemonApp
RemoveDirpropertyfpMkUnitDirectory removal command and options
RemoveFromSessionStateprocedureHTTPDefs
RemoveItemprocedurefpMkUnitRemoves a variable or function from the dictionary
RemoveModuleprocedurefpHTTPRemoves a module from the factory
RemoveNonExistingpropertyfpJsonApplyControls whether to remove properties from source that do not exist in apply JSON
RemoveParamprocedureDBRemove a parameter from the collection.
RemovePointerfunctionAVL_TreeRemove a pointer item from the list.
RemoveRecordFromIndexprocedureBufDataset
RemoveRecordFromIndexprocedureBufDatasetRemove the record at the specified bookmark from the index.
RemoveRecordFromIndexprocedureBufDatasetRemoves the record at the specified Bookmark from the index.
RemoveRecordFromIndexprocedureBufDataset
RemoveRowprocedureCsvDocumentRemove a row.
RemoveTrailingEmptyCellsprocedureCsvDocumentRemove empty cells at the end of each row.
RemoveTreepropertyfpMkUnitDirectory tree removal command and options
RemoveVariableprocedureHTTPDefsRemoves a variable from the session
RenamefunctionContnrsRename a key.
RenameprocedureContnrsRename the object.
RenamefunctionContnrsRename a key.
RenameprocedureIniFilesRename the ini file.
ReplaceStringsfunctionfpMkUnitPerforms string substitution using dictionary variables
ReplaceTagprocedurefpTemplate
ReplaceTagfunctionfpTemplateReplace a tag with a value.
ReportAsStringfunctionAVL_TreeReturn the tree report as a string.
ReportStatusprocedureDaemonAppReport the current status to the operating system.
ReportStatusfunctionDaemonAppReport the status to the operating system.
RequestpropertyfpHTTPCurrent HTTP request
RequestpropertyFpWebThe current HTTP request being processed
RequestpropertyHTTPDefsAssociated HTTP request object
RequestBodypropertyfpHTTPClient
RequestBodypropertyfpHTTPClientThe request body content for POST/PUT requests
RequestCookiespropertyfpHTTPClient
RequestCookiespropertyfpHTTPClientCookies to send with requests
RequestExistsfunctionAdvancedIPC
RequestFileNameToIDfunctionAdvancedIPC
RequestHeaderspropertyfpHTTPClient
RequestHeaderspropertyfpHTTPClientHTTP headers to send with requests
RequestIDpropertyHTTPDefsUnique request identifier
RequestUploadDirfunctionHTTPDefs
RequireChecksumpropertyfpMkUnitControls checksum verification for the dependency
RequiredpropertyDBDoes the field require a value.
RequiredpropertyDBIs the field required ?
ResetprocedureBase64Reset the stream.
ResetprocedureLibTarReset archive.
ResetprocedureStreamExReset the stream to its original position.
ResetprocedureStreamExReset the stream to its original position.
ResetprocedureStreamExReset the stream to its original position.
ResetprocedureStreamExReset the reader to the start position.
ResetprocedureSyncObjs
ResetprocedureSyncObjs
resetprocedureZStream
ResetBuilderprocedureCsvReadWriteReset values.
ResetEventprocedureSyncObjsReset the event.
ResetHandlesprocedureProcess
ResetParserprocedureCsvReadWriteReset the parser to its initial state.
ResolvedCORSAllowedOriginsfunctionHTTPDefsResolves allowed origins for CORS requests
ResolveFileNamesprocedurefpMkUnitResolves and validates file paths for package targets
ResolvePackagePathprocedurefpMkUnitResolves package path location
ResolvePackagePathprocedurefpMkUnitDelegates package path resolution to plugins
ResolvePackagePathprocedurefpMkUnitResolves package path using plugin logic
ResolvePackagePathsprocedurefpMkUnit
ResolveProcessHandlefunctionProcess
ResolveRelativeURIfunctionURIParserReturn a relative link.
ResolveStreamfunctionProcess
ResourceFilespropertyfpMkUnitCollection of resource files for the target
ResourceStringspropertyfpMkUnitWhether to generate resource string support for the target
ResponsevariableBufDataset
ResponsepropertyfpHTTPCurrent HTTP response
ResponsepropertyFpWebThe current HTTP response being generated
ResponseCookiespropertyfpHTTPClient
ResponseCookiespropertyfpHTTPClientCookies received from the server in the last response
ResponseHeaderspropertyfpHTTPClient
ResponseHeaderspropertyfpHTTPClientHTTP headers received from server responses
ResponseStatusCodepropertyfpHTTPClient
ResponseStatusCodepropertyfpHTTPClientHTTP status code from the last response
ResponseStatusTextpropertyfpHTTPClient
ResponseStatusTextpropertyfpHTTPClientHTTP status text from the last response
ResStringvariablefpExprParsString value when result type is string
RestoreBlobFieldprocedureBufDataset
RestoreCurrentRecordprocedureBufDataset
RestoreCurrentRecordprocedureBufDatasetRestores the stored record buiffer to the current record.
RestoreCurrentRecordprocedureBufDataset
RestoreCurrentRecordprocedureBufDataset
RestoreRecordprocedureBufDataset
RestoreRecordprocedureBufDataset
RestoreStateprocedureDB
ResultTypefunctionfpExprParsGet the result type of the expression
ResultTypepropertyfpExprParsThe result type of the identifier
ResultTypeNamefunctionfpExprParsGet name for result type
ResumeprocedureEventLogResume sending of log messages if sending was paused.
ResumefunctionProcessResume execution of a suspended process.
ResyncprocedureDBResynchronize the data buffer.
RetrievingSchemaInformationtopicSQLDBRetrieving Schema Information.
RetryvariableHTTPDefsRetry interval for the event
RetryAfterpropertyHTTPDefsRetry-After header field value
RetryAfterpropertyHTTPDefsRetry-After header value indicating when to retry request
ReturnedPathInfopropertyHTTPDefsPath info that was returned from GetNextPathInfo
RevertRecordprocedureBufDatasetReverts the current record to its original (un-edited) values.
RevisionvariableFileInfoRevision version number
revisionvariableGetTextFile revision.
RightvariableAVL_TreeReference to the right subtree of the current node.
RightpropertyfpExprParsRight operand of the binary operation
RolepropertyMSSQLConnRole for user.
RolepropertySQLDBRole in which the user is connecting to the database.
RollbackprocedureDB
RollBackfunctionIBConnection
RollbackfunctionMSSQLConn
RollBackfunctionSQLDB
RollBackfunctionSQLDB
RollbackprocedureSQLDBRoll back all changes made in the current transaction.
RollbackRetainingprocedureDB
RollBackRetainingprocedureIBConnection
RollbackRetainingprocedureMSSQLConn
RollBackRetainingprocedureSQLDB
RollBackRetainingprocedureSQLDB
RollbackRetainingprocedureSQLDBRoll back changes made in the transaction, keep transaction context.
RootpropertyAVL_TreeRoot node of the tree.
RotateLeftprocedureAVL_Tree
RotateRightprocedureAVL_Tree
ROUNDSconstantIdeaNumber of rounds to encrypt.
RouteCountpropertyHTTPRouteReturns the number of registered routes
RouteIDpropertyfpHTTP
RouteMethodNamesconstantHTTPRouteArray constant containing HTTP method name strings
RouteMethodToStringfunctionHTTPRouteConverts route method enumeration to string
RouteOptionspropertyHTTPRouteGlobal options for route matching
RouteParamspropertyHTTPDefsRoute parameter value by name
RouteRequestprocedureHTTPRouteRoutes an HTTP request to appropriate handler
RoutespropertyHTTPRouteProvides indexed access to routes
RoutespropertyHTTPRouteProvides indexed access to routes
RowCountpropertyCsvDocumentNumber of available rows.
RowEndprocedureWFormatEnds the current table row
RowEndprocedureWHtmlEnds HTML table row
RowEndprocedureWMarkDownCompletes table row with separator line
RowEndprocedureWTexEnds LaTeX table row
RowEndprocedureWTextCompletes table row with formatting
RowNextprocedureWFormatMoves to the next table row
RowsAffectedfunctionIBConnection
RowsAffectedfunctionMSSQLConn
RowsAffectedfunctionSQLDBReturn the number of rows (records) affected by the last DML/DDL statement.
RowsAffectedfunctionSQLDBNumber of rows affected by the SQL statement.
RowsAffectedfunctionSQLDB
RowsAffectedfunctionSQLDB
RowStartprocedureWFormatBegins a new table row
RowStartprocedureWHtmlBegins HTML table row
RowStartprocedureWMarkDownBegins table row with pipe
RowStartprocedureWTexBegins LaTeX table row
RowStartprocedureWTextBegins table row
RowStateToBytefunctionBufDataset
RSHashfunctionContnrsStandard hash value calculating function.
RsjExtconstantfpMkUnitResource string JSON file extension
RSJFileNamepropertyfpMkUnitResource string JSON filename for the target
RstExtconstantfpMkUnitResource string file extension
RSTFileNamepropertyfpMkUnitResource string table filename for the target
RTLStringtypefpMkUnitRuntime library string type
RTLStringtypeHTTPDefsRuntime library string type
RuleprocedureWFormatInserts a horizontal rule
RuleprocedureWHtmlInserts HTML horizontal rule tag
RuleprocedureWMarkDownWrites horizontal rule
RuleprocedureWTexInserts LaTeX horizontal rule
RuleprocedureWTextWrites horizontal rule
RunprocedureCustAppRuns the application.
RunprocedureCustWebMain request processing loop for the web handler
RunprocedureEzCgiRun the CGI application.
RunfunctionfpMkUnitExecutes the installer with the current configuration
RunArgumentspropertyDaemonAppAdditional command-line arguments when running daemon.
RunCommandfunctionProcessExecute a command in the current working directory.
RunCommandIndirfunctionProcessRun a command in a specific directory.
RunCommandLoopfunctionProcessExecute command and collect output in strings.
RunCommandSleepTimepropertyProcessSleep time between attempts to collect data.
RunDaemonsprocedureDaemonAppRun all daemons.
RunInterceptfunctionHTTPRoute
RunInterceptsfunctionHTTPRouteExecutes interceptors at specified timing
RunModepropertyDaemonAppApplication mode.
RunModepropertyfpMkUnitCurrent operation mode of the installer
RunningpropertyProcessDetermines whether the process is still running.

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