Sign in Join
FPDoc Onlineexperiment

Types unit

Various types.

Starting with D6, types from Windows specific units that were needed in Kylix were extracted to this unit. So it mostly contains type of Windows origin that are needed in the VCL framework.

Classes and records

_FILETIMErecordFiletime record type.
IClassFactoryinterfaceClass defined for ActiveX compatibility.
ISequentialStreaminterfaceSequential stream object interface.
IStreaminterfaceCOM stream abstraction.
tagSTATSTGrecordStorage statistics type for IStream interface.
TBitConverterclass
TNullPtrrecord
TPointrecordPoint in a plane.
TPoint3Drecord
TPointFrecord
TRectrecordRectangle in a plane.
TRectFrecord
TScopedrecord
TSizerecordArea size.
TSizeFrecord
TSmallPointrecordSmall point.
TXrmOptionDescRecrecordOpaque record type.

Procedures and functions

BoundsfunctionCreate a rectangle, given a position and size.
CenteredRectfunction
CenterPointfunctionReturn the center point of a rectangle.
EqualRectfunctionCheck if two rectangles are equal.
InflateRectfunctionIncrease the rectangle in size, keeping it centered.
IntersectRectfunctionReturn the intersection of 2 rectangles.
IntersectRectFfunction
IsRectEmptyfunctionCheck whether a rectangle is empty.
MinPointfunction
MultiplyRectprocedure
NormalizeRectfunction
NormalizeRectFfunction
OffsetRectfunctionOffset the rectangle.
PointfunctionCreate a point.
PointFfunction
PtInRectfunctionCheck whether a point is inside a rectangle.
RectfunctionCreate a rectangle record.
RectCenterfunction
RectFfunction
RectHeightfunction
RectWidthfunction
ScalePointfunction
SizefunctionReturn the size of the rectangle.
SplitRectfunction
UnionRectfunctionReturn the union of 2 rectangles.
UnionRectFfunction

Types

ArgListtypeUntyped pointer type.
DWORDtypeAlias for cardinal type.
FILETIMEtypeAlias for the _FILETIME type.
LARGE_INTtypeAlias for the Int64 type.
LARGE_UINTtypeAlias for the QWord type.
LargeinttypeAlias for the Int64 type.
LargeUinttypeAlias for the QWord type.
PBytetypePointer to byte type.
PCLSIDtypePointer to TCLSID type.
PDisplaytypeUntyped pointer type.
PDoubletypePointer do double type.
PDWordtypePointer to DWord type.
PEventtypeUntyped pointer type.
PFileTimetypePointer to TFileTime type.
PLargeInttypePointer to LargeInt.
PLargeuInttypePointer to QWord type.
PLonginttypePointer to longint type.
POleStrtypePointer to WideChar.
PPointtypePointer to TPoint type.
PPointFtype
PPOleStrtypePointer to POleStr type.
PRecttypePointer to TRect structure.
PRectFtype
PSizetypePointer to TSize type.
PSizeFtype
PSmallInttypePointer to smallint type.
PSmallPointtypePointer to TSmallPoint type.
PStatStgtypePointer to TStatStg record.
PXrmOptionDescRectypePointer to TXrmOptionDescRec.
RegiontypeUntyped pointer type.
STATSTGtypeAlias for the TStatStg type.
TagPointtypeAlias for TPoint.
TagSizetypeAlias for TSize.
TAnsiStringDynArraytype
TArray4IntegerTypetype
TBooleanDynArraytypeDynamic array of booleans.
TByteDynArraytypeDynamic array of (8-bit, unsigned) bytes.
TCardinalDynArraytypeDynamic array of (32-bit, unsigned) cardinals.
TClassicByteDynArraytype
TClassicStringDynArraytype
TCLSIDtypeClass ID identifier (GUID).
TCompDynArraytype
TCurrencyArraytype
TDirectionenumeration
TDoubleDynArraytypeDynamic array of (Double-sized) floats.
TDuplicatesenumerationEnumeration type, indicating what to do with duplicates in a list.
TEndiantype
TExtendedDynArraytype
TFileTimetypeAlias for the _FILETIME type.
THorzRectAlignenumeration
TInt64DynArraytypeDynamic array of (64-bit, signed) int64s.
TIntegerDynArraytypeDynamic array of (32-bit, signed) integers.
TListCallbackprocedure typeMethod callback for list operations.
TListStaticCallbackprocedure typeCallback for list operations.
TLongWordDynArraytypeDynamic array of (32-bit, unsigned) LongWords.
TObjectDynArraytype
TOleChartypeAlias for the widechar type.
TPointerDynArraytypeDynamic array of untyped pointers.
TQWordDynArraytypeDynamic array of (64-bit, unsigned) QWords.
TRTLStringDynArraytype
TShortIntDynArraytypeDynamic array of (8-bit, signed) shortints.
TSingleDynArraytypeArray of (single-sized) floats.
TSmallIntDynArraytypeDynamic array of (16-bit, signed) smallints.
TSplitRectTypeenumeration
TStatStgtypeRecord describing storage medium.
TStringDynArraytypeDynamic array of AnsiStrings.
TUnicodeStringDynArraytype
TValueRelationshiptype
TVertRectAlignenumeration
TWideStringDynArraytypeDynamic array of WideStrings.
TWordDynArraytypeDynamic array of (16-bit, unsigned) words.
WidgettypeUntyped pointer type.
WidgetClasstypeUntyped pointer type.
XrmOptionDescRectypeAlias for TXrmOptionDescRec.

Constants

cPIconstant
cPIdiv180constant
cPIdiv2constant
cPIdiv4constant
CurveKappaconstant
CurveKappaInvconstant
E_FAILconstantCOM/RPC Error code : operation failed.
E_INVALIDARGconstantCOM/RPC Error code: Invalid arguments were specified.
Epsilonconstant
Epsilon2constant
EqualsValueconstant
GreaterThanValueconstant
GUID_NULLconstantNull GUID.
LessThanValueconstant
LOCK_EXCLUSIVEconstantStorage Lock stream data: lock exclusively for writing operation.
LOCK_ONLYONCEconstantStorage Lock stream data: lock is granted only once.
LOCK_WRITEconstantStorage Lock stream data: lock for writing operation.
NullPtrconstant
STATFLAG_DEFAULTconstantStorage Statistics should contain pwcsName structure.
STATFLAG_NONAMEconstantStorage Statistics must not contain pwcsName structure.
STATFLAG_NOOPENconstantStorage : Not implemented.
STG_E_ABNORMALAPIEXITconstantStorage COM/RPC Error code: Abnormal exit of an API call.
STG_E_ACCESSDENIEDconstantStorage COM/RPC Error code: access to specified resource is denied.
STG_E_BADBASEADDRESSconstantStorage COM/RPC Error code: wrong address for OLE32.
STG_E_CANTSAVEconstantStorage COM/RPC Error code: cannot save.
STG_E_DISKISWRITEPROTECTEDconstantStorage COM/RPC Error code: Disk is read-only.
STG_E_DOCFILECORRUPTconstantStorage COM/RPC Error code: Document file is corrupted.
STG_E_EXTANTMARSHALLINGSconstantStorage COM/RPC Error code: extant marshallings exist on object.
STG_E_FILEALREADYEXISTSconstantStorage COM/RPC Error code: the specified object already exists.
STG_E_FILENOTFOUNDconstantStorage COM/RPC Error code: the file could not be found.
STG_E_INCOMPLETEconstantStorage COM/RPC Error code: download interrupted, resulting in incomplete file.
STG_E_INSUFFICIENTMEMORYconstantStorage COM/RPC Error code: not enough operation for the operation.
STG_E_INUSEconstantStorage COM/RPC Error code: object is in use.
STG_E_INVALIDFLAGconstantStorage COM/RPC Error code: invalid flag.
STG_E_INVALIDFUNCTIONconstantStorage COM/RPC Error code: An invalid operation was called.
STG_E_INVALIDHANDLEconstantStorage COM/RPC Error code: invalid object for operation.
STG_E_INVALIDHEADERconstantStorage COM/RPC Error code: Not a valid compound file.
STG_E_INVALIDNAMEconstantStorage COM/RPC Error code: Not a valid name.
STG_E_INVALIDPARAMETERconstantStorage COM/RPC Error code: an invalid parameter was specified.
STG_E_INVALIDPOINTERconstantStorage COM/RPC Error code: invalid pointer specified.
STG_E_LOCKVIOLATIONconstantStorage COM/RPC Error code: A locking violation occurred.
STG_E_MEDIUMFULLconstantStorage COM/RPC Error code: the medium was full.
STG_E_NOMOREFILESconstantStorage COM/RPC Error code: no more objects to return.
STG_E_NOTCURRENTconstantStorage COM/RPC Error code: contents changed by another user.
STG_E_OLDDLLconstantStorage COM/RPC Error code: old format of DLL.
STG_E_OLDFORMATconstantStorage COM/RPC Error code: old compound file format.
STG_E_PATHNOTFOUNDconstantStorage COM/RPC Error code: the path could not be found.
STG_E_PROPSETMISMATCHEDconstantStorage COM/RPC Error code: Attempt to write a complex property to a simple property storage.
STG_E_READFAULTconstantStorage COM/RPC Error code: Error during read operation.
STG_E_REVERTEDconstantStorage COM/RPC Error code: object no longer exists.
STG_E_SEEKERRORconstantStorage COM/RPC Error code: Error during seek operation.
STG_E_SHAREREQUIREDconstantStorage COM/RPC Error code: share.exe required for this operation.
STG_E_SHAREVIOLATIONconstantStorage COM/RPC Error code: A sharing violation occurred.
STG_E_TERMINATEDconstantStorage COM/RPC Error code: download terminated.
STG_E_TOOMANYOPENFILESconstantStorage COM/RPC Error code: too many open files.
STG_E_UNIMPLEMENTEDFUNCTIONconstantStorage COM/RPC Error code: unimplemented function.
STG_E_UNKNOWNconstantStorage COM/RPC Error code: unknown error.
STG_E_WRITEFAULTconstantStorage COM/RPC Error code: Error during write operation.
STG_S_BLOCKconstantStorage COM/RPC Error code: storage operation would block till more data comes available.
STG_S_CONVERTEDconstantStorage COM/RPC Error code: object was converted to compound file.
STG_S_MONITORINGconstantStorage COM/RPC Error code: ?
STG_S_RETRYNOWconstantStorage COM/RPC Error code: Retry operation.
STGTY_LOCKBYTESconstantStorage type - byte array.
STGTY_PROPERTYconstantStorage type - Property storage.
STGTY_STORAGEconstantStorage type - Storage.
STGTY_STREAMconstantStorage type - stream.
STREAM_SEEK_CURconstantStorage Stream seek operation offset type : relative position.
STREAM_SEEK_ENDconstantStorage Stream seek operation offset type : Position relative to end of stream.
STREAM_SEEK_SETconstantStorage Stream seek operation offset type : set absolute position.

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