System.NetEncoding.TSqidsEncoding.Encode

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function Encode(const ANumbers: TArray<Integer>): string; overload;
function Encode(const ANumber: Integer): string; overload;
function Encode(const ANumbers: string): string; overload;

C++

System::UnicodeString __fastcall Encode(const System::DynamicArray<int> ANumbers)/* overload */;
System::UnicodeString __fastcall Encode(const int ANumber)/* overload */;
System::UnicodeString __fastcall Encode(const System::UnicodeString ANumbers)/* overload */;

Properties

Type Visibility Source Unit Parent
function public
System.NetEncoding.pas
System.NetEncoding.hpp
System.NetEncoding TSqidsEncoding

Description

Encodes specified input values and returns Sqids "hash" string value.

Encode accepts three data types as arguments:

  • ANumbers: TArray<Integer> (i.e., an array of integers).
  • ANumber: Integer (i.e., a single integer value).
  • ANumbers: String (i.e., a string with comma-separated integer values).
Note: Encode raises an exception when the argument is a negative integer.

See Also