X# Runtime and VO SDK Reference

XSharp.RT Namespace

Functions, Globals and Defines

List of Functions

_accept Function (RT)

_ArrayToObjectArray Function (RT)

_ArrayToUsualArray Function (RT)

_Break Function (RT)

_CallClipFunc Function (RT)

_CreateInstance Function (RT)

_GetMRandID Function (RT)

_HasClipFunc Function (RT)

_MClear Function (RT)

_MRelease Function (RT)

_MRestore Function (RT)

_MSave Function (RT)

_MxRelease Function (RT)

_NoAlias Function (RT)

_ObjectArrayToUsualArray Function (RT)

_PrivateCount Function (RT)

_PrivateEnum Function (RT)

_PrivateFirst Function (RT)

_PrivateNext Function (RT)

_PublicCount Function (RT)

_PublicEnum Function (RT)

_PublicFirst Function (RT)

_PublicNext Function (RT)

_RegisterExit Function (RT)

_Select Function (RT)

_SelectString Function (RT)

_SequenceError Function (RT)

_SequenceRecover Function (RT)

_Str Function (RT)

_Str3 Function (RT)

_TextRestore Function (RT)

_TextSave Function (RT)

_UsualArrayToObjectArray Function (RT)

_VoDbErrInfoPtr Function (RT)

_wait Function (RT)

AAdd Function (RT)

Abs Function (RT)

AbsFloat Function (RT)

AClone Function (RT)

ACloneShallow Function (RT)

ADimPic Function (RT)

ADir Function (RT)

AEval Function (RT)

AEvalA Function (RT)

AEvalOld Function (RT)

AFields Function (RT)

Alias0Sym Function (RT)

AllowCollectThread Function (RT)

Ansi2OemBuff Function (RT)

AReplicate Function (RT)

Array Function (RT)

ArrayBuild Function (RT)

ArrayCreate Function (RT)

ArrayDeProtect Function (RT)

ArrayGet Function (RT)

ArrayInit Function (RT)

ArrayNew Function (RT)

ArrayProtect Function (RT)

ArrayPut Function (RT)

ArrayStore Function (RT)

ArraySwap Function (RT)

AScan Function (RT)

AScanBin Function (RT)

AScanBinExact Function (RT)

AScanExact Function (RT)

ASend Function (RT)

AsHexString Function (RT)

AsString Function (RT)

AsSymbol Function (RT)

ATail Function (RT)

ATan Function (RT)

Atan2 Function (RT)

ATrueDel Function (RT)

Between Function (RT)

Bin2Date Function (RT)

Bin2F Function (RT)

Bin2Logic Function (RT)

BLOBDirectExport Function (RT)

BLOBDirectGet Function (RT)

BLOBDirectImport Function (RT)

BLOBDirectPut Function (RT)

BLOBExport Function (RT)

BLOBGet Function (RT)

BLOBImport Function (RT)

BLOBRootGet Function (RT)

BLOBRootLock Function (RT)

BLOBRootPut Function (RT)

BLOBRootUnlock Function (RT)

Bof Function (RT)

CanBreak Function (RT)

CDoW Function (RT)

Ceil Function (RT)

CheckInstanceOf Function (RT)

ClassCount Function (RT)

ClassList Function (RT)

ClassName Function (RT)

ClassTree Function (RT)

ClassTreeClass Function (RT)

cls Function (RT)

CMonth Function (RT)

Col Function (RT)

Collect Function (RT)

CollectCount Function (RT)

CollectForced Function (RT)

ConcatAtom Function (RT)

ConcatAtom3 Function (RT)

ConcatAtom4 Function (RT)

ConcatAtom5 Function (RT)

ConDate Function (RT)

Cos Function (RT)

Cot Function (RT)

CParamCount Function (RT)

CreateInstance Function (RT)

CSend Function (RT)

CToD Function (RT)

CToDAnsi Function (RT)

Date Function (RT)

Date2Bin Function (RT)

Day Function (RT)

DbApp Function (RT)

DbAppDelim Function (RT)

DbAppend Function (RT)

DbAppSdf Function (RT)

DbAutoLock Function (RT)

DbAutoLockArea Function (RT)

DbAutoUnLock Function (RT)

DbAutoUnLockArea Function (RT)

DbBlobInfo Function (RT)

DbBuffRefresh Function (RT)

DbClearFilter Function (RT)

DbClearIndex Function (RT)

DBClearOrderCondition Function (RT)

DbClearRelation Function (RT)

DbClearScope Function (RT)

DbCloseAll Function (RT)

DbCloseArea Function (RT)

DbCommit Function (RT)

DbCommitAll Function (RT)

DbContinue Function (RT)

DbCopy Function (RT)

DbCopyDelim Function (RT)

DbCopySDF Function (RT)

DbCopyStruct Function (RT)

DbCopyXStruct Function (RT)

DbCreate Function (RT)

DbCreateIndex Function (RT)

DbCreateOrder Function (RT)

DbDelete Function (RT)

DbDeleteOrder Function (RT)

DbDriver Function (RT)

DbEval Function (RT)

DBF Function (RT)

DbFieldInfo Function (RT)

DBFileCopy Function (RT)

DbFilter Function (RT)

DbGetSelect Function (RT)

DbGoBottom Function (RT)

DbGoto Function (RT)

DbGoTop Function (RT)

DbInfo Function (RT)

DbJoin Function (RT)

DbJoinAppend Function (RT)

DbLocate Function (RT)

DbMemoExt Function (RT)

DbMemoField Function (RT)

DbOrderInfo Function (RT)

DbPack Function (RT)

DbRecall Function (RT)

DbRecordInfo Function (RT)

DbReindex Function (RT)

DbRelation Function (RT)

DbRLock Function (RT)

DbRLockList Function (RT)

DbRSelect Function (RT)

DbRUnLock Function (RT)

DbScope Function (RT)

DbSeek Function (RT)

DbSelect Function (RT)

DbSelectArea Function (RT)

DbSetDriver Function (RT)

DbSetFilter Function (RT)

DbSetFound Function (RT)

DbSetIndex Function (RT)

DbSetOrder Function (RT)

DbSetOrderCondition Function (RT)

DbSetRelation Function (RT)

DbSetScope Function (RT)

DbSetSelect Function (RT)

DbSkip Function (RT)

DbSort Function (RT)

DbStruct Function (RT)

DbSymSelect Function (RT)

DbTotal Function (RT)

DbTrans Function (RT)

DbUnLock Function (RT)

DbUnLockAll Function (RT)

DbUpdate Function (RT)

DbUseArea Function (RT)

DbZap Function (RT)

DebOut Function (RT)

Default Function (RT)

Deleted Function (RT)

Descend Function (RT)

DescendA Function (RT)

DirChange Function (RT)

Directory Function (RT)

DirMake Function (RT)

DirRemove Function (RT)

DiskChange Function (RT)

DoError Function (RT)

EmptyField Function (RT)

EmptyPSZ Function (RT)

EmptyRecord Function (RT)

EmptyString Function (RT)

EmptyUsual Function (RT)

EnableArrayIndexCheck Function (RT)

EnableLBOptimizations Function (RT)

EnforceNumeric Function (RT)

EnforceType Function (RT)

Eof Function (RT)

ErrorBlock Function (RT)

ErrorExec Function (RT)

ErrorSys Function (RT)

Eval Function (RT)

Evaluate Function (RT)

ExecScript Function (RT)

ExecScriptFast Function (RT)

FieldBlock Function (RT)

FieldBlockSym Function (RT)

FieldGet Function (RT)

FieldGetAlias Function (RT)

FieldGetArea Function (RT)

FieldGetBytes Function (RT)

FieldGetSelect Function (RT)

FieldGetSym Function (RT)

FieldName Function (RT)

FieldPos Function (RT)

FieldPosSym Function (RT)

FieldPut Function (RT)

FieldPutAlias Function (RT)

FieldPutArea Function (RT)

FieldPutBytes Function (RT)

FieldPutSelect Function (RT)

FieldPutSym Function (RT)

FieldSym Function (RT)

FieldWBlock Function (RT)

FieldWBlockSym Function (RT)

FindClass Function (RT)

Float2Long Function (RT)

FloatFormat Function (RT)

Flock Function (RT)

Floor Function (RT)

Found Function (RT)

FParamCount Function (RT)

FReadLine Function (RT)

FReadText3 Function (RT)

FSeek Function (RT)

FWrite Function (RT)

FWrite3 Function (RT)

FWriteLine Function (RT)

FWriteText Function (RT)

GetColor Function (RT)

GetRTFullPath Function (RT)

GetThreadCount Function (RT)

GetTickCountLow Function (RT)

Header Function (RT)

InCollect Function (RT)

IndexCount Function (RT)

IndexExt Function (RT)

IndexHPLock Function (RT)

IndexKey Function (RT)

IndexOrd Function (RT)

InList Function (RT)

InListExact Function (RT)

Integer Function (RT)

IsAccess Function (RT)

IsArray Function (RT)

IsAssign Function (RT)

IsBinary Function (RT)

IsByRef Function (RT)

IsClass Function (RT)

IsClassOf Function (RT)

IsCodeBlock Function (RT)

IsCurrency Function (RT)

IsDate Function (RT)

IsDateTime Function (RT)

IsDecimal Function (RT)

IsFloat Function (RT)

IsFractional Function (RT)

IsInstanceOf Function (RT)

IsInstanceOfUsual Function (RT)

IsInt64 Function (RT)

IsInteger Function (RT)

IsLogic Function (RT)

IsLong Function (RT)

IsMethod Function (RT)

IsMethodClass Function (RT)

IsMethodUsual Function (RT)

IsNil Function (RT)

IsNumeric Function (RT)

IsObject Function (RT)

IsPtr Function (RT)

IsString Function (RT)

IsSymbol Function (RT)

IVarGet Function (RT)

IVarGetInfo Function (RT)

IVarGetSelf Function (RT)

IvarList Function (RT)

IvarListClass Function (RT)

IVarPut Function (RT)

IVarPutInfo Function (RT)

IVarPutSelf Function (RT)

JCDOW Function (RT)

JCMONTH Function (RT)

JCYEAR Function (RT)

LastRec Function (RT)

Len Function (RT)

LOG Function (RT)

Log10 Function (RT)

LUpdate Function (RT)

MAssign Function (RT)

Max Function (RT)

MaxAtom Function (RT)

MCompile Function (RT)

Mem2String Function (RT)

MemAlloc Function (RT)

MemAtSpecial Function (RT)

MemByte Function (RT)

MemCAlloc Function (RT)

MemChr Function (RT)

MemClear Function (RT)

MemComp Function (RT)

MemCopy Function (RT)

MemCopyString Function (RT)

MemDWord Function (RT)

MemFree Function (RT)

MemGrpAlloc Function (RT)

MemGrpCAlloc Function (RT)

MemGrpClose Function (RT)

MemGrpEnum Function (RT)

MemGrpOpen Function (RT)

MemInt Function (RT)

MemLen Function (RT)

MemLong Function (RT)

MemLower Function (RT)

MemMove Function (RT)

MemoTran Function (RT)

MemRealloc Function (RT)

MemSet Function (RT)

MemShort Function (RT)

MemTotal Function (RT)

MemTrace Function (RT)

MemUpper Function (RT)

MemVarBlock Function (RT)

MemVarBlockSym Function (RT)

MemVarClear Function (RT)

MemVarGet Function (RT)

MemVarGetSym Function (RT)

MemVarPut Function (RT)

MemVarPutSym Function (RT)

MemVarRelease Function (RT)

MemVarTryGet Function (RT)

MemWalk Function (RT)

MemWord Function (RT)

MethodList Function

MethodListClass Function

MExec Function (RT)

Min Function (RT)

MLCount Function (RT)

MLcToPos Function (RT)

MLPos Function (RT)

Mod Function (RT)

Month Function (RT)

MParamCount Function (RT)

MPosToLc Function (RT)

NewIndexLock Function (RT)

NewLocks Function (RT)

NoMethod Function (RT)

NTrim Function (RT)

Object2Array Function (RT)

Object2Float Function (RT)

Oem2AnsiBuff Function (RT)

OOPTree Function (RT)

OOPTreeClass Function (RT)

OrdBagExt Function (RT)

OrdBagName Function (RT)

OrdCondSet Function (RT)

OrdCount Function (RT)

OrdCreate Function (RT)

OrdDescend Function (RT)

OrdDestroy Function (RT)

OrdFor Function (RT)

OrdIsUnique Function (RT)

OrdKey Function (RT)

OrdKeyAdd Function (RT)

OrdKeyCount Function (RT)

OrdKeyDel Function (RT)

OrdKeyGoto Function (RT)

OrdKeyNo Function (RT)

OrdKeyVal Function (RT)

OrdList Function (RT)

OrdListAdd Function (RT)

OrdListClear Function (RT)

OrdListRebuild Function (RT)

OrdName Function (RT)

OrdNumber Function (RT)

OrdScope Function (RT)

OrdSetFocus Function (RT)

OrdSetRelation Function (RT)

OrdSkipUnique Function (RT)

PaletteRGB Function (RT)

Pause Function (RT)

PI Function (RT)

Pow Function (RT)

Psz2String Function (RT)

Psz2Usual Function (RT)

PszAlloc Function (RT)

RddCount Function (RT)

RddInfo Function (RT)

RddList Function (RT)

RddName Function (RT)

RddSetDefault Function (RT)

RddVersion Function (RT)

RecCount Function (RT)

RecNo Function (RT)

RecSize Function (RT)

RegisterAxit Function (RT)

SetAlternate Function (RT)

SetAltFile Function (RT)

SetColor Function (RT)

SetConsole Function (RT)

SetFDateTime Function (RT)

SetFloatDelta Function (RT)

SetPos Function (RT)

SetTextFile Function (RT)

SetTextOutPut Function (RT)

SEval Function (RT)

SEvalA Function (RT)

ShowArray Function (RT)

ShowObject Function (RT)

ShowPrivates Function (RT)

ShowPublics Function (RT)

Sin Function (RT)

SplitPath Function (RT)

StrEvaluate Function (RT)

StrFloat Function (RT)

String2Atom Function (RT)

String2Symbol Function (RT)

StringAlloc Function (RT)

StrInt Function (RT)

StrLong Function (RT)

StrToFloat Function (RT)

StrTran Function (RT)

StrZero Function (RT)

SubS Function (RT)

SubStr Function (RT)

Symbol2String Function (RT)

SysAddAtom Function (RT)

SysAddAtomUpperA Function (RT)

SysCompAtom Function (RT)

SysFindAtom Function (RT)

SysGetAtomName Function (RT)

Tan Function (RT)

TimePsz Function (RT)

TimePsz24 Function (RT)

Today Function (RT)

Tone Function (RT)

ToWord Function (RT)

Transform Function (RT)

TString Function (RT)

Type Function (RT)

Unformat Function (RT)

UnRegisterAxit Function (RT)

Used Function (RT)

UsualType Function (RT)

UsualVal Function (RT)

Val Function (RT)

ValType Function (RT)

VarGet Function (RT)

VarGetSym Function (RT)

VarPut Function (RT)

VarPutSym Function (RT)

Version Function (RT)

VoDbAlias Function (RT)

VoDbAliasSym Function (RT)

VoDbAppend Function (RT)

VoDbBlobInfo Function (RT)

VoDbBof Function (RT)

VoDbBuffRefresh Function (RT)

VoDbClearFilter Function (RT)

VoDbClearLocate Function (RT)

VoDbClearRelation Function (RT)

VoDbClearScope Function (RT)

VoDbCloseAll Function (RT)

VoDbCloseArea Function (RT)

VoDbCommit Function (RT)

VoDbCommitAll Function (RT)

VoDbContinue Function (RT)

VoDbCreate Function (RT)

VoDbDelete Function (RT)

VoDbDeleted Function (RT)

VoDbEof Function (RT)

VoDbEval Function (RT)

VoDbFieldGet Function (RT)

VoDbFieldGetBytes Function (RT)

VoDbFieldInfo Function (RT)

VoDbFieldPut Function (RT)

VoDbFieldPutBytes Function (RT)

VoDbFileGet Function (RT)

VoDbFilePut Function (RT)

VoDbFilter Function (RT)

VoDbFlock Function (RT)

VoDbFound Function (RT)

VoDbGetScope Function (RT)

VoDbGetSelect Function (RT)

VoDbGoBottom Function (RT)

VoDbGoto Function (RT)

VoDbGoTop Function (RT)

VoDbInfo Function (RT)

VoDbJoinAppend Function (RT)

VoDbLastRec Function (RT)

VoDbLocate Function (RT)

VoDbMemoExt Function (RT)

VoDbOrdBagExt Function (RT)

VoDbOrdCondSet Function (RT)

VoDbOrdCreate Function (RT)

VoDbOrdDestroy Function (RT)

VoDbOrderInfo Function (RT)

VoDbOrdListAdd Function (RT)

VoDbOrdListClear Function (RT)

VoDbOrdListRebuild Function (RT)

VoDbOrdSetFocus Function (RT)

VoDbPack Function (RT)

VoDbRddCount Function (RT)

VoDbRddInfo Function (RT)

VoDbRddList Function (RT)

VoDbRddName Function (RT)

VoDbRddSetDefault Function (RT)

VoDbRecall Function (RT)

VoDbRecno Function (RT)

VoDbRecordGet Function (RT)

VoDbRecordInfo Function (RT)

VoDbRecordPut Function (RT)

VoDbRelation Function (RT)

VoDbRlock Function (RT)

VoDbRSelect Function (RT)

VoDbSeek Function (RT)

VoDbSelect Function (RT)

VoDbSetFilter Function (RT)

VoDbSetFound Function (RT)

VoDbSetLocate Function (RT)

VoDbSetRelation Function (RT)

VoDbSetScope Function (RT)

VoDbSetSelect Function (RT)

VoDbSkip Function (RT)

VoDbSkipScope Function (RT)

VoDbSort Function (RT)

VoDbSymSelect Function (RT)

VoDbTrans Function (RT)

VoDbTransRec Function (RT)

VoDbUnlock Function (RT)

VoDbUnLockAll Function (RT)

VoDbUseArea Function (RT)

VoDbZap Function (RT)

XSharpLoadLibrary Function (RT)

Year Function (RT)

FReadText3 Function

Read characters from a file into a buffer variable that is passed by reference.

Namespace: XSharp.RT
Assembly: XSharp.RT (in XSharp.RT.dll) Version: 2.19

Syntax

Copy

 FUNCTION FReadText3(
	ptrHandle AS IntPtr,
	pData AS IntPtr,
	dwBytes AS DWORD
) AS DWORD

public static uint FReadText3(
	IntPtr ptrHandle,
	IntPtr pData,
	uint dwBytes
)

Request Example View Source

Parameters

ptrHandle: Type: IntPtr
The handle of the file to read from.
pData: Type: IntPtr
A block of memory to store the data read from the specified file. The length of this variable must be greater than or equal to the number of bytes in the next parameter.
dwBytes: Type: DWord
The number of bytes to read into the buffer.

Return Value

Type: DWord
The number of bytes successfully read.
A return value less than dwBytes or 0 indicates end-of-file or some other read error. FError() can be used to determine the specific error.

Remarks

FReadText() is the same as FRead() except that an OEM to ANSI conversion is made if SetAnsi() is FALSE.

Remarks

Tip
This function is included for compatibility. We do not recomment using static memory for file i/o operations. We recommend that you use the function overload that takes a byte array parameter in stead.

Examples

This example uses FRead() after successfully opening a file to read 128 bytes into a buffer area:

Copy

 1DEFINE F_BLOCK := 128
 2...
 3cBuffer := Space(F_BLOCK)
 4ptrHandle := FOpen("temp.txt")
 5IF FError() != 0
 6    ? DOSErrString(FError())
 7ELSE
 8    IF FReadText(ptrHandle, @cBuffer, F_BLOCK) <paramref name="" /> F_BLOCK
 9        ? DOSErrString(FError())
10    ENDIF
11    FClose(ptrHandle)
12ENDIF

Reference

Functions, Globals and Defines

FReadStr(IntPtr, DWord)

FReadText3(IntPtr, IntPtr, DWord)

FSeek(Usual, Usual, Usual)

FWriteLine(Usual, Usual, Usual)

Oem2Ansi

SetAnsi