Sign in Join
FPDoc Onlineexperiment

CreateGUID function

In unit sysutils

Create a new GUID.

Declaration

pascal
function CreateGUID(out GUID: TGUID): Integer

Description

CreateGUID can be called to create a new GUID (Globally Unique Identifier) value. The function returns the new GUID value in GUID and returns zero in case the GUID was created successfully. If no GUID was created, a nonzero error code is returned.

The default mechanism for creating a new GUID is system dependent. If operating system support is available, it is used. If none is available, a default implementation using random numbers is used.

The OnCreateGUID callback can be set to hook a custom mechanism behind the CreateGUID function. This can be used to let the GUID be created by an external GUID creation library.

Errors

On error, a nonzero return value is returned.

See also

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