X# Runtime and VO SDK Reference
X# Runtime and SDK Reference
XSharp.VFP Namespace
Functions, Globals and Defines
List of Functions
AClass Function (VFP)
ADatabases Function (VFP)
ADBObjects Function (VFP)
AddBs Function (VFP)
AddProperty Function (VFP)
ADel Function (VFP)
ADLLS Function (VFP)
ADOCKSTATE Function (VFP)
AElement Function (VFP)
AERROR Function (VFP)
AEVENTS Function (VFP)
AFONT Function (VFP)
AGETCLASS Function (VFP)
AGetFileVersion Function (VFP)
AIns Function (VFP)
AINSTANCE Function (VFP)
ALANGUAGE Function (VFP)
ALen Function (VFP)
ALines Function (VFP)
AllTrim Function (VFP)
AMembers Function (VFP)
AMOUSEOBJ Function (VFP)
ANetResources Function (VFP)
APrinters Function (VFP)
APROCINFO Function (VFP)
ASELOBJ Function (VFP)
ASessions Function (VFP)
ASize Function (VFP)
ASqlHandles Function (VFP)
AStackInfo Function (VFP)
ASubScript Function (VFP)
At Function (VFP)
At_C Function (VFP)
ATagInfo Function (VFP)
AtC Function (VFP)
AtCC Function (VFP)
AUsed Function (VFP)
AVCXCLASSES Function (VFP)
BagCount Function (VFP)
BAR Function (VFP)
BARCOUNT Function (VFP)
BARPROMPT Function (VFP)
BINDEVENT Function (VFP)
BinToc Function (VFP)
BitAnd Function (VFP)
BitClear Function (VFP)
BitLShift Function (VFP)
BitNot Function (VFP)
BitOr Function (VFP)
BitRShift Function (VFP)
BitSet Function (VFP)
BitTest Function (VFP)
BitXor Function (VFP)
Candidate Function (VFP)
CapsLock Function (VFP)
Cdx Function (VFP)
Ceiling Function (VFP)
ChrTran Function (VFP)
ChrTranC Function (VFP)
COMARRAY Function (VFP)
COMCLASSINFO Function (VFP)
CompObj Function (VFP)
COMPROP Function (VFP)
COMRETURNERROR Function (VFP)
CpConvert Function (VFP)
CpCurrent Function (VFP)
CpDbf Function (VFP)
CREATEBINARY Function (VFP)
CreateObject Function (VFP)
CreateObjectEx Function (VFP)
CreateOffline Function (VFP)
CToBin Function (VFP)
CToT Function (VFP)
CursorGetProp Function (VFP)
CursorSetProp Function (VFP)
CursorToXML Function (VFP)
CurVal Function (VFP)
DbAlias Function (VFP)
DbAppDelimFox Function (VFP)
DbAppendFromArray Function (VFP)
DbAppFox Function (VFP)
Dbc Function (VFP)
DbCopyDelimFox Function (VFP)
DbCopyFox Function (VFP)
DbCopyStructFox Function (VFP)
DbCopyToArray Function (VFP)
DbCopyXStructFox Function (VFP)
DbGetProp Function (VFP)
DbSeekFox Function (VFP)
DbSetProp Function (VFP)
DbSortFox Function (VFP)
DbUseAreaFox Function (VFP)
DbUsed Function (VFP)
DDEAbortTrans Function (VFP)
DDEAdvise Function (VFP)
DDEEnabled Function (VFP)
DDEExecute Function (VFP)
DDEInitiate Function (VFP)
DDELastError Function (VFP)
DDEPoke Function (VFP)
DDERequest Function (VFP)
DDESetOption Function (VFP)
DDESetService Function (VFP)
DDESetTopic Function (VFP)
DDETerminate Function (VFP)
DefaultExt Function (VFP)
Descending Function (VFP)
Difference Function (VFP)
DisplayPath Function (VFP)
DMY Function (VFP)
DriveType Function (VFP)
DropOffLine Function (VFP)
DToT Function (VFP)
EDITSOURCE Function (VFP)
ERROR Function (VFP)
EVENTHANDLER Function (VFP)
EVL Function (VFP)
Field Function (VFP)
FileToStr Function (VFP)
Filter Function (VFP)
FKLABEL Function (VFP)
FKMAX Function (VFP)
FldCount Function (VFP)
FldList Function (VFP)
FontMetric Function (VFP)
For Function (VFP)
ForceExt Function (VFP)
ForcePath Function (VFP)
FullPath Function (VFP)
FV Function (VFP)
GetAutoIncValue Function (VFP)
GETBAR Function (VFP)
GetColor Function (VFP)
GetCp Function (VFP)
GetCursorAdapter Function (VFP)
GetDir Function (VFP)
GetFile Function (VFP)
GetFldState Function (VFP)
GetFont Function (VFP)
GETINTERFACE Function (VFP)
GetNextModified Function (VFP)
GetObject Function (VFP)
GETPAD Function (VFP)
GETPEM Function (VFP)
GetPict Function (VFP)
GetPrinter Function (VFP)
GetResultSet Function (VFP)
GetWordCount Function (VFP)
GetWordNum Function (VFP)
GoMonth Function (VFP)
HOME Function (VFP)
Hour Function (VFP)
ICase Function (VFP)
Id Function (VFP)
IdxCollate Function (VFP)
ImeStatus Function (VFP)
InDbc Function (VFP)
IndexSeek Function (VFP)
INKEY Function (VFP)
InputBox Function (VFP)
InsMode Function (VFP)
IsBlank Function (VFP)
IsColor Function (VFP)
IsExclusive Function (VFP)
IsFlocked Function (VFP)
ISLEADBYTE Function (VFP)
IsMemoFetched Function (VFP)
IsMouse Function (VFP)
IsNull Function (VFP)
IsPen Function (VFP)
IsReadOnly Function (VFP)
IsRlocked Function (VFP)
IsTransactable Function (VFP)
JustDrive Function (VFP)
JustExt Function (VFP)
JustFName Function (VFP)
JustPath Function (VFP)
JustStem Function (VFP)
Key Function (VFP)
KeyMatch Function (VFP)
LASTKEY Function (VFP)
LeftC Function (VFP)
LenC Function (VFP)
LikeC Function (VFP)
LineNo Function (VFP)
LoadPicture Function (VFP)
LocFile Function (VFP)
Lock Function (VFP)
Lookup Function (VFP)
LTrim Function (VFP)
MakeTransactable Function (VFP)
Mdx Function (VFP)
MDY Function (VFP)
MEMORY Function (VFP)
MENU Function (VFP)
MESSAGE Function (VFP)
MessageBox Function (VFP)
Minute Function (VFP)
MkDir Function (VFP)
MRKBAR Function (VFP)
MRKPAD Function (VFP)
MROW Function (VFP)
MToN Function (VFP)
MWINDOW Function (VFP)
Ndx Function (VFP)
NewObject Function (VFP)
Normalize Function (VFP)
NToM Function (VFP)
NumLock Function (VFP)
NVL Function (VFP)
OBJTOCLIENT Function (VFP)
OldVal Function (VFP)
ON Function (VFP)
Order Function (VFP)
PAD Function (VFP)
PADPROMPT Function (VFP)
PARAMETERS Function (VFP)
Payment Function (VFP)
PCol Function (VFP)
PEMSTATUS Function (VFP)
POPUP Function (VFP)
Primary Function (VFP)
PRINTSTATUS Function (VFP)
PRMBAR Function (VFP)
PRMPAD Function (VFP)
Program Function (VFP)
PROMPT Function (VFP)
PRow Function (VFP)
PrtInfo Function (VFP)
PutFile Function (VFP)
PV Function (VFP)
Quarter Function (VFP)
RaiseEvent Function (VFP)
RAt Function (VFP)
RAtC Function (VFP)
RDLEVEL Function (VFP)
READKEY Function (VFP)
Refresh Function (VFP)
RegisterFoxMemVarSupport Function (VFP)
Relation Function (VFP)
RemoveProperty Function (VFP)
Requery Function (VFP)
RgbScheme Function (VFP)
RightC Function (VFP)
RTrim Function (VFP)
SavePicture Function (VFP)
Scheme Function (VFP)
SCOLS Function (VFP)
Sec Function (VFP)
Seek Function (VFP)
SetFldState Function (VFP)
SetFoxCollation Function (VFP)
SetResultSet Function (VFP)
SetTextFile Function (VFP)
SetTextMerge Function (VFP)
SetTextMergeDelimiters Function (VFP)
ShowFoxArray Function (VFP)
Sign Function (VFP)
SKPBAR Function (VFP)
SKPPAD Function (VFP)
SqlCancel Function (VFP)
SqlColumns Function (VFP)
SqlCommit Function (VFP)
SqlConnect Function (VFP)
SqlDisconnect Function (VFP)
SqlExec Function (VFP)
SqlGetProp Function (VFP)
SqlIdleDisconnect Function (VFP)
SqlMoreResults Function (VFP)
SqlParameters Function (VFP)
SqlPrepare Function (VFP)
SqlRollBack Function (VFP)
SqlSetFactory Function (VFP)
SqlSetProp Function (VFP)
SqlStringConnect Function (VFP)
SqlTables Function (VFP)
SROWS Function (VFP)
Str Function (VFP)
StrConv Function (VFP)
StrExtract Function (VFP)
StrToFile Function (VFP)
StuffC Function (VFP)
SubStrC Function (VFP)
Sys Function (VFP)
SysMetric Function (VFP)
TableRevert Function (VFP)
TableUpdate Function (VFP)
Tag Function (VFP)
TagCount Function (VFP)
TagNo Function (VFP)
Target Function (VFP)
TextMerge Function (VFP)
Transform Function (VFP)
Trim Function (VFP)
TToC Function (VFP)
TToD Function (VFP)
TxnLevel Function (VFP)
TxtWidth Function (VFP)
UNBINDEVENTS Function (VFP)
Unique Function (VFP)
UPDATED Function (VFP)
VARREAD Function (VFP)
VarType Function (VFP)
WBORDER Function (VFP)
WCHILD Function (VFP)
WCOLS Function (VFP)
WDOCKABLE Function (VFP)
Week Function (VFP)
WEXIST Function (VFP)
WFONT Function (VFP)
WLAST Function (VFP)
WLCOL Function (VFP)
WLROW Function (VFP)
WMAXIMUM Function (VFP)
WMINIMUM Function (VFP)
WONTOP Function (VFP)
WOUTPUT Function (VFP)
WPARENT Function (VFP)
WREAD Function (VFP)
WROWS Function (VFP)
WTITLE Function (VFP)
WVISIBLE Function (VFP)
XmlToCursor Function (VFP)
XmlUpdatefram Function (VFP)
Click or drag to resize

APrinters Function

X#
Stores information about currently-available printers into an array.
The behavior of this function is OS (operating system) - specific. X# may or may not check to see if the printers are actually connected to your computer when it prepares this list, and the list may include all printers installed as printer setups, or only those available on the current network.

Namespace:  XSharp.VFP
Assembly:  XSharp.VFP (in XSharp.VFP.dll) Version: 2.21
Syntax
Copy
 FUNCTION APrinters(
	ArrayName,
	nValue
) AS LONG CLIPPER
Request Example View Source

Parameters

ArrayName (Optional)
Type: Usual
Specifies the name of the array containing information about printers.
nValue (Optional)
Type: Usual
Specifies a value that creates a two-column array or five-column array. Each row in the array contains information about a printer.
The table in the remarks section describes the possible values of nValue.

Return Value

Type: Long
Numeric. APRINTERS( ) returns the number of rows in the array or 0 when no printers are available.
Remarks
If the array you include does not exist, X# automatically creates the array. If the array exists but is not large enough to contain all the information, X# increases the size of the array to accommodate the information. If the array is larger than necessary, X# truncates the array. If the array exists but APRINTERS( ) returns 0 because no printers are available, the array remains unchanged. If the array does not exist, and APRINTERS( ) returns 0, the array is not created.

nValueDescription
0 or omitted Return a two-column array containing the following items beginning with the first column:
  • Printer name.
  • Name of the port to which the printer is connected.
1 Return a five-column array containing the following items beginning with the first column:
  • Printer name.
  • Name of the port to which the printer is connected.
  • Name of the printer driver.
  • Printer comment.
  • Printer location.
Examples
X#
Copy
1IF APRINTERS(gaPrinters) > 0
2Clear  // clear the current output window
3Display MEMORY LIKE gaPrinters // show the contents of the array
4ELSE
5WAIT 'No printers found.'
6ENDIF
See Also