X# Runtime Reference
X# Runtime Reference
XSharp.RT
Functions, Globals and Defines
List of Functions
__AreaEval Function
__FieldGet Function
__FieldGetWa Function
__FieldSet Function
__FieldSetWa Function
__MemVarDecl Function
__MemVarGet Function
__MemVarInit Function
__MemVarPut Function
__MemVarRelease Function
__popWorkarea Function
__pushWorkarea Function
__StringCompare Function
__StringEquals Function
__StringNotEquals Function
__VarGet Function
__VarPut Function
_accept Function
_ArrayToObjectArray Function
_ArrayToUsualArray Function
_Break Function
_CallClipFunc Function
_GetMRandID Function
_MClear Function
_MRelease Function
_MRestore Function
_MSave Function
_MxRelease Function
_ObjectArrayToUsualArray Function
_PrivateCount Function
_PrivateEnum Function
_PrivateFirst Function
_PrivateNext Function
_PublicCount Function
_PublicEnum Function
_PublicFirst Function
_PublicNext Function
_Select Function
_SelectString Function
_Str Function
_Str3 Function
_UsualArrayToObjectArray Function
_VoDbErrInfoPtr Function
_wait Function
AAdd Function
Abs Function
AbsFloat Function
AClone Function
ACloneShallow Function
ACopy Function
ACot Function
ADel Function
ADim Function
ADimPic Function
ADir Function
AEval Function
AEvalA Function
AEvalOld Function
AFields Function
AFill Function
AIns Function
ALen Function
Alias Function
Alias0 Function
Alias0Sym Function
AllowCollectThread Function
Ansi2OemBuff Function
AReplicate Function
ArrayBuild Function
ArrayCreate Function
ArrayDeProtect Function
ArrayGet Function
ArrayInit Function
ArrayNew Function
ArrayProtect Function
ArrayPut Function
ArrayStore Function
ArraySwap Function
AScan Function
AScanBin Function
AScanBinExact Function
AScanExact Function
ASend Function
AsHexString Function
ASize Function
ASort Function
AsPadr Function
AsString Function
AsSymbol Function
ATail Function
ATan Function
ATrueDel Function
Between Function
Bin2Date Function
Bin2F Function
Bin2Logic Function
BLOBDirectExport Function
BLOBDirectGet Function
BLOBDirectImport Function
BLOBDirectPut Function
BLOBExport Function
BLOBGet Function
BLOBImport Function
BLOBRootGet Function
BLOBRootLock Function
BLOBRootPut Function
BLOBRootUnlock Function
Bof Function
CanBreak Function
CDoW Function
Ceil Function
CheckInstanceOf Function
ClassCount Function
ClassList Function
ClassName Function
ClassTree Function
ClassTreeClass Function
cls Function
CMonth Function
Col Function
Collect Function
CollectCount Function
CollectForced Function
ConcatAtom Function
ConcatAtom3 Function
ConcatAtom4 Function
ConcatAtom5 Function
ConDate Function
Cos Function
Cot Function
CParamCount Function
CreateInstance Function
CSend Function
CToD Function
CToDAnsi Function
Date2Bin Function
Day Function
DbApp Function
DbAppDelim Function
DbAppend Function
DbAppSdf Function
DbBlobInfo Function
DbBuffRefresh Function
DbClearFilter Function
DbClearIndex Function
DBClearOrderCondition Function
DbClearRelation Function
DbClearScope Function
DbCloseAll Function
DbCloseArea Function
DbCommit Function
DbCommitAll Function
DbContinue Function
DbCopy Function
DbCopyDelim Function
DbCopySDF Function
DbCopyStruct Function
DbCopyXStruct Function
DbCreate Function
DbCreateIndex Function
DbCreateOrder Function
DbDelete Function
DbDeleteOrder Function
DbDriver Function
DbEval Function
DBF Function
DbFieldInfo Function
DBFileCopy Function
DbFilter Function
DbGetSelect Function
DbGoBottom Function
DbGoto Function
DbGoTop Function
DbInfo Function
DbJoin Function
DbJoinAppend Function
DbLocate Function
DbMemoExt Function
DbMemoField Function
DbOrderInfo Function
DbPack Function
DbRecall Function
DbRecordInfo Function
DbReindex Function
DbRelation Function
DbRLock Function
DbRLockList Function
DbRSelect Function
DbRUnLock Function
DbScope Function
DbSeek Function
DbSelect Function
DbSelectArea Function
DbSetDriver Function
DbSetFilter Function
DbSetFound Function
DbSetIndex Function
DbSetOrder Function
DbSetOrderCondition Function
DbSetRelation Function
DbSetScope Function
DbSetSelect Function
DbSkip Function
DbSort Function
DbStruct Function
DbSymSelect Function
DbTotal Function
DbTrans Function
DbUnLock Function
DbUnlockAll Function
DbUpdate Function
DbUseArea Function
DbZap Function
DebOut Function
DEFAULT Function
Deleted Function
Descend Function
DescendA Function
DirChange Function
Directory Function
DirMake Function
DirRemove Function
DiskChange Function
DoError Function
DoW Function
DToC Function
DToS Function
Empty Function
EmptyField Function
EmptyPSZ Function
EmptyRecord Function
EmptyString Function
EmptyUsual Function
EnableLBOptimizations Function
EnforceNumeric Function
EnforceType Function
Eof Function
ErrorBlock Function
Eval Function
Evaluate Function
Exp Function
F2Bin Function
Fact Function
FCount Function
FieldBlock Function
FieldBlockSym Function
FieldGet Function
FieldGetAlias Function
FieldGetArea Function
FieldGetBytes Function
FieldGetSelect Function
FieldGetSym Function
FieldName Function
FieldPos Function
FieldPosSym Function
FieldPut Function
FieldPutAlias Function
FieldPutArea Function
FieldPutBytes Function
FieldPutSelect Function
FieldPutSym Function
FieldSym Function
FieldWBlock Function
FieldWBlockSym Function
FindClass Function
Float2Long Function
FloatFormat Function
Flock Function
Floor Function
Found Function
FParamCount Function
Frac Function
FRead Function
FRead3 Function
FRead4 Function
FReadLine Function
FReadText3 Function
FSeek Function
FWrite Function
FWrite3 Function
FWriteLine Function
FWriteText Function
GetRTFullPath Function
GetThreadCount Function
GetTickCountLow Function
Header Function
InCollect Function
IndexCount Function
IndexExt Function
IndexHPLock Function
IndexKey Function
IndexOrd Function
InList Function
InListExact Function
Integer Function
IsAccess Function
IsArray Function
IsAssign Function
IsByRef Function
IsClass Function
IsClassOf Function
IsCodeBlock Function
IsDate Function
IsDateTime Function
IsDecimal Function
IsFloat Function
IsFractional Function
IsInstanceOf Function
IsInstanceOfUsual Function
IsInt64 Function
IsInteger Function
IsLogic Function
IsLong Function
IsMethod Function
IsMethodClass Function
IsMethodUsual Function
IsNil Function
IsNumeric Function
IsObject Function
IsPtr Function
IsString Function
IsSymbol Function
IVarGet Function
IVarGetInfo Function
IVarGetSelf Function
IvarList Function
IvarListClass Function
IVarPut Function
IVarPutInfo Function
IVarPutSelf Function
JCDOW Function
JCMONTH Function
JCYEAR Function
LastRec Function
Len Function
LOG Function
Log10 Function
LUpdate Function
MAssign Function
Max Function
MaxAtom Function
MCompile Function
MemAlloc Function
MemAtSpecial Function
MemByte Function
MemCAlloc Function
MemChr Function
MemClear Function
MemComp Function
MemCopy Function
MemCopyString Function
MemDWord Function
MemFree Function
MemGrpAlloc Function
MemGrpCAlloc Function
MemGrpClose Function
MemGrpEnum Function
MemGrpOpen Function
MemInt Function
MemLen Function
MemLong Function
MemLower Function
MemMove Function
MemoTran Function
MemRealloc Function
MemSet Function
MemShort Function
MemTotal Function
MemTrace Function
MemUpper Function
MemVarBlock Function
MemVarBlockSym Function
MemVarClear Function
MemVarGet Function
MemVarGetSym Function
MemVarPut Function
MemVarPutSym Function
MemVarRelease Function
MemWalk Function
MemWord Function
MethodList Function
MethodListClass Function
MExec Function
Min Function
MLCount Function
MLcToPos Function
MLPos Function
Month Function
MParamCount Function
MPosToLc Function
NewIndexLock Function
NewLocks Function
NoMethod Function
NTrim Function
Object2Array Function
Object2Float Function
Oem2AnsiBuff Function
OOPTree Function
OOPTreeClass Function
OrdBagExt Function
OrdBagName Function
OrdCondSet Function
OrdCount Function
OrdCreate Function
OrdDescend Function
OrdDestroy Function
OrdFor Function
OrdIsUnique Function
OrdKey Function
OrdKeyAdd Function
OrdKeyCount Function
OrdKeyDel Function
OrdKeyGoto Function
OrdKeyNo Function
OrdKeyVal Function
OrdList Function
OrdListAdd Function
OrdListClear Function
OrdListRebuild Function
OrdName Function
OrdNumber Function
OrdScope Function
OrdSetFocus Function
OrdSetRelation Function
OrdSkipUnique Function
Pad Function
PadC Function
PadL Function
PadR Function
PaletteRGB Function
Pause Function
Pow Function
Psz2String Function
Psz2Usual Function
PszAlloc Function
PszLen Function
QOut Function
QQOut Function
Rand Function
RddCount Function
RddInfo Function
RddList Function
RddName Function
RddSetDefault Function
RddVersion Function
RecCount Function
RecNo Function
RecSize Function
RegisterAxit Function
RLock Function
Round Function
Row Function
Select Function
Send Function
Set Function
SetFDateTime Function
SetFloatDelta Function
SetPos Function
SEval Function
ShowArray Function
Sin Function
SplitPath Function
SQrt Function
SToD Function
Str Function
Str1 Function
Str2 Function
Str3 Function
StrFloat Function
String2Atom Function
String2Symbol Function
StringAlloc Function
StrInt Function
StrLong Function
StrToFloat Function
StrTran Function
StrZero Function
SubS Function
SubStr Function
Symbol2String Function
SysAddAtom Function
SysAddAtomUpperA Function
SysCompAtom Function
SysFindAtom Function
SysGetAtomName Function
SysObject Function
Tan Function
TimePsz Function
TimePsz24 Function
Today Function
Tone Function
ToWord Function
Transform Function
TString Function
Type Function
Unformat Function
UnRegisterAxit Function
Used Function
UsualType Function
UsualVal Function
Val Function
ValType Function
VarGet Function
VarGetSym Function
VarPut Function
VarPutSym Function
Version Function
VoDbAlias Function
VoDbAliasSym Function
VoDbAppend Function
VoDbBlobInfo Function
VoDbBof Function
VoDbBuffRefresh Function
VoDbClearFilter Function
VoDbClearLocate Function
VoDbClearRelation Function
VoDbClearScope Function
VoDbCloseAll Function
VoDbCloseArea Function
VoDbCommit Function
VoDbCommitAll Function
VoDbContinue Function
VoDbCreate Function
VoDbDelete Function
VoDbDeleted Function
VoDbEof Function
VoDbEval Function
VoDbFieldGet Function
VoDbFieldInfo Function
VoDbFieldPut Function
VoDbFileGet Function
VoDbFilePut Function
VoDbFilter Function
VoDbFlock Function
VoDbFound Function
VoDbGetSelect Function
VoDbGoBottom Function
VoDbGoto Function
VoDbGoTop Function
VoDbInfo Function
VoDbJoinAppend Function
VoDbLastRec Function
VoDbLocate Function
VoDbMemoExt Function
VoDbOrdBagExt Function
VoDbOrdCondSet Function
VoDbOrdCreate Function
VoDbOrdDestroy Function
VoDbOrderInfo Function
VoDbOrdListAdd Function
VoDbOrdListClear Function
VoDbOrdListRebuild Function
VoDbOrdSetFocus Function
VoDbPack Function
VoDbRddCount Function
VoDbRddInfo Function
VoDbRddList Function
VoDbRddName Function
VoDbRddSetDefault Function
VoDbRecall Function
VoDbRecno Function
VoDbRecordGet Function
VoDbRecordInfo Function
VoDbRecordPut Function
VoDbRelation Function
VoDbRlock Function
VoDbRSelect Function
VoDbSeek Function
VoDbSelect Function
VoDbSetFilter Function
VoDbSetFound Function
VoDbSetLocate Function
VoDbSetRelation Function
VoDbSetScope Function
VoDbSetSelect Function
VoDbSkip Function
VoDbSkipScope Function
VoDbSort Function
VoDbSymSelect Function
VoDbTrans Function
VoDbTransRec Function
VoDbUnlock Function
VoDbUnlockAll Function
VoDbUseArea Function
VoDbZap Function
XSharpLoadLibrary Function
Year Function
Click or drag to resize

SubS Function

Extract a substring from a string.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.08
Syntax
Copy
 FUNCTION SubS(
	 cTarget AS USUAL,
	 nStart AS USUAL,
	 nCount AS USUAL
) AS STRING
View Source

Parameters

cTarget
Type: Usual
The string from which to extract a substring.
nStart
Type: Usual
The starting position in <cTarget>.  If <wStart> is positive, it is relative to the leftmost character in <cTarget>.  If <nStart> is negative, it is relative to the rightmost character in <cTarget>.  If <nStart> is zero, a NULL_STRING is returned.
nCount
Type: Usual
The number of characters to extract.  If omitted, the substring begins at <nStart> and continues to the end of the string.  If <nCount> is greater than the number of characters from <nStart> to the end of <cTarget>, the extra is ignored.

Return Value

Type: String
The substring.  If the substring is not present, a NULL_STRING is returned.
Remarks
Substr() is related to the Left() and Right() functions, which extract substrings beginning with leftmost and rightmost characters in <cTarget>, respectively. The Substr(), Right(), and Left() functions are often used with both the At() and RAt() functions to locate either the first and/or the last position of a substring before extracting it.  They are also used to display or print only a portion of a string.
Examples
These examples extract the first and last name from a variable:
X#
Copy
cName := "Biff Styvesent"
? Substr(cName, 1, 4)                                // Biff
? Substr(cName, 6)                                        // Styvesent
? Substr(cName, SLen(cName) + 2)
// Null string
? Substr(cName, -9)                                        // Styvesent
? Substr(cName, -9, 3)                                // Sty
This example uses Substr() with At() and RAt() to create a function to extract a file name from a file specification:
X#
Copy
? FileBase("c:\prg\myfile.obj")                // myfile.obj
FUNCTION FileBase(cFile)
        LOCAL nPos AS DWORD
        IF (nPos := RAt("\", cFile)) != 0
                cFile := Substr(cFile, nPos + 1)
        ELSEIF (nPos := At(":", cFile)) != 0
                cFile := Substr(cFile, nPos + 1)
        ENDIF
        RETURN cFile
See Also