xPC Target™

API Function and Method Reference

C API Functions

Logging, Scope, and File System Structures	Data structures for data logging and scopes
Communications Functions	Communicate between host and target PCs
Target Application Functions	Manipulate target applications
Data Logging Functions	Log data
Scope Functions	Manipulate scopes
File System Functions	Manipulate file systems
Target Scope Functions	Manipulate scopes of type target
Monitoring and Tuning Functions	Monitor and tune parameters and signals
Miscellaneous Functions	Manipulate miscellaneous xPC Target components

Logging, Scope, and File System Structures

dirStruct	Type definition for file system directory information structure
diskinfo	Type definition for file system disk information structure
lgmode	Type definition for logging options structure
scopedata	Type definition for scope data structure

Communications Functions

xPCCloseConnection	Close RS-232 or TCP/IP communication connection
xPCClosePort	Close RS-232 or TCP/IP communication connection
xPCDeRegisterTarget	Delete target communication properties from xPC Target™ API library
xPCGetLoadTimeOut	Return timeout value for communication between host PC and target PC
xPCOpenConnection	Open connection to target PC
xPCOpenSerialPort	Open RS-232 connection to xPC Target™ system
xPCOpenTcpIpPort	Open TCP/IP connection to xPC Target™ system
xPCReboot	Reboot target PC
xPCRegisterTarget	Register target with xPC Target™ API library
xPCReOpenPort	Reopen communication channel
xPCSetLoadTimeOut	Change initialization timeout value between host PC and target PC
xPCTargetPing	Ping target PC

Target Application Functions

xPCAverageTET	Return average task execution time
xPCGetAPIVersion	Get version number of xPC Target™ API
xPCGetAppName	Return target application name
xPCGetExecTime	Return target application execution time
xPCGetSampleTime	Return target application sample time
xPCGetStopTime	Return stop time
xPCGetTargetVersion	Get xPC Target™ kernel version
xPCIsAppRunning	Return target application running status
xPCIsOverloaded	Return target PC overload status
xPCLoadApp	Load target application onto target PC
xPCLoadParamSet	Restore parameter values
xPCMaximumTET	Copy maximum task execution time to array
xPCMinimumTET	Copy minimum task execution time to array
xPCSaveParamSet	Save parameter values of target application
xPCSetSampleTime	Change target application sample time
xPCSetStopTime	Change target application stop time
xPCStartApp	Start target application
xPCStopApp	Stop target application
xPCUnloadApp	Unload target application

Data Logging Functions

xPCGetLogMode	Return logging mode and increment value for target application
xPCGetNumOutputs	Return number of outputs
xPCGetNumStates	Return number of states
xPCGetOutputLog	Copy output log data to array
xPCGetStateLog	Copy state log values to array
xPCGetTETLog	Copy TET log to array
xPCGetTimeLog	Copy time log to array
xPCMaxLogSamples	Return maximum number of samples that can be in log buffer
xPCNumLogSamples	Return number of samples in log buffer
xPCNumLogWraps	Return number of times log buffer wraps
xPCSetLogMode	Set logging mode and increment value of scope

Scope Functions

xPCAddScope	Create new scope
xPCGetScope	Get and copy scope data to structure
xPCGetScopes	Get and copy list of scope numbers
xPCIsScFinished	Return data acquisition status for scope
xPCRemScope	Remove scope
xPCScAddSignal	Add signal to scope
xPCScGetData	Copy scope data to array
xPCScGetDecimation	Return decimation of scope
xPCScGetNumPrePostSamples	Get number of pre- or posttriggering samples before triggering scope
xPCScGetNumSamples	Get number of samples in one data acquisition cycle
xPCScGetSignals	Copy list of signals to array
xPCScGetStartTime	Get start time for last data acquisition cycle
xPCScGetState	Get state of scope
xPCScGetTriggerLevel	Get trigger level for scope
xPCScGetTriggerMode	Get trigger mode for scope
xPCScGetTriggerScope	Get trigger scope
xPCScGetTriggerScopeSample	Get sample number for triggering scope
xPCScGetTriggerSignal	Get trigger signal for scope
xPCScGetTriggerSlope	Get trigger slope for scope
xPCScGetType	Get type of scope
xPCScRemSignal	Remove signal from scope
xPCScSetDecimation	Set decimation of scope
xPCScSetNumPrePostSamples	Set number of pre- or posttriggering samples before triggering scope
xPCScSetNumSamples	Set number of samples in one data acquisition cycle
xPCScSetTriggerLevel	Set trigger level for scope
xPCScSetTriggerMode	Set trigger mode of scope
xPCScSetTriggerScope	Select scope to trigger another scope
xPCScSetTriggerScopeSample	Set sample number for triggering scope
xPCScSetTriggerSignal	Select signal to trigger scope
xPCScSetTriggerSlope	Set slope of signal that triggers scope
xPCScSoftwareTrigger	Set software trigger of scope
xPCScStart	Start data acquisition for scope
xPCScStop	Stop data acquisition for scope
xPCSetScope	Set properties of scope

File System Functions

xPCFSCD	Change current directory on target PC to specified path
xPCFSCloseFile	Close file on target PC
xPCFSDir	Get contents of specified directory on target PC
xPCFSDirItems	Get contents of specified directory on target PC
xPCFSDirSize	Return size of specified directory on target PC
xPCFSDirStructSize	Get number of items in directory
xPCFSDiskInfo	Information about target PC file system
xPCFSGetError	Get text description for error number on target PC file system
xPCFSGetFileSize	Return size of file on target PC
xPCFSGetPWD	Get current directory of target PC
xPCFSOpenFile	Open file on target PC
xPCFSReadFile	Read open file on target PC
xPCFSRemoveFile	Remove file from target PC
xPCFSRMDIR	Remove directory from target PC
xPCFSScGetFilename	Get name of file for scope
xPCFSScGetWriteMode	Get write mode of file for scope
xPCFSScGetWriteSize	Get block write size of data chunks
xPCFSScSetFilename	Specify name for file to contain signal data
xPCFSScSetWriteMode	Specify when file allocation table entry is updated
xPCFSScSetWriteSize	Specify that memory buffer collect data in multiples of write size
xPCFSWriteFile	Write to file on target PC

Target Scope Functions

xPCTgScGetGrid	Get status of grid line for particular scope
xPCTgScGetMode	Get scope mode for displaying signals
xPCTgScGetViewMode	Get view mode for target PC display
xPCTgScGetYLimits	Copy y-axis limits for scope to array
xPCTgScSetGrid	Set grid mode for scope
xPCTgScSetMode	Set display mode for scope
xPCTgScSetViewMode	Set view mode for scope
xPCTgScSetYLimits	Set y-axis limits for scope

Monitoring and Tuning Functions

xPCGetNumParams	Return number of tunable parameters
xPCGetNumSignals	Return number of signals
xPCGetParam	Get parameter value and copy it to array
xPCGetParamDims	Get row and column dimensions of parameter
xPCGetParamIdx	Return parameter index
xPCGetParamName	Get name of parameter
xPCGetSigIdxfromLabel	Return array of signal indices
xPCGetSigLabelWidth	Return number of elements in signal
xPCGetSignal	Return value of signal
xPCGetSignalIdx	Return index for signal
xPCGetSignalName	Copy name of signal to character array
xPCGetSignals	Return vector of signal values
xPCGetSignalWidth	Return width of signal
xPCSetParam	Change value of parameter

Miscellaneous Functions

xPCErrorMsg	Return text description for error message
xPCFreeAPI	Unload xPC Target™ DLL
xPCGetEcho	Return display mode for target message window
xPCGetLastError	Return constant of last error
xPCInitAPI	Initialize xPC Target™ DLL
xPCSetEcho	Turn message display on or off
xPCSetLastError	Set last error to specific string constant

COM API Methods

Communication Objects (xPCProtocol)	Work with COM API communication objects
Scope Objects (xPCScopes)	Work with COM API scope objects
Target Objects (xPCTarget)	Work with COM API Target objects
File System Objects (xPCFileSystem)	Work with COM API file system objects

Communication Objects (xPCProtocol)

xPCProtocol.Close	Close RS-232 or TCP/IP communication connection
xPCProtocol.GetLoadTimeOut	Return current timeout value for target application initialization
xPCProtocol.GetxPCErrorMsg	Return error string
xPCProtocol.Init	Initialize xPC Target™ API DLL
xPCProtocol.isxPCError	Return error status
xPCProtocol.Port	Contain communication channel index
xPCProtocol.Reboot	Reboot target PC
xPCProtocol.RS232Connect	Open RS-232 connection to target PC
xPCProtocol.SetLoadTimeOut	Change initialization timeout value
xPCProtocol.TargetPing	Ping target PC
xPCProtocol.TcpIpConnect	Open TCP/IP connection to target PC
xPCProtocol.Term	Unload xPC Target™ API DLL from memory

Scope Objects (xPCScopes)

xPCScopes.AddFileScope	Create new scope of type file
xPCScopes.AddHostScope	Create new scope of type host
xPCScopes.AddTargetScope	Create new scope of type target
xPCScopes.GetScopes	Get and copy list of scope numbers
xPCScopes.GetxPCError	Get error string
xPCScopes.Init	Initialize scope object to communicate with target PC
xPCScopes.IsScopeFinished	Get data acquisition status for scope
xPCScopes.isxPCError	Get error status
xPCScopes.RemScope	Remove scope
xPCScopes.ScopeAddSignal	Add signal to scope
xPCScopes.ScopeGetData	Copy scope data to array
xPCScopes.ScopeGetDecimation	Get decimation of scope
xPCScopes.ScopeGetNumPrePostSamples	Get number of pre- or posttriggering samples before triggering scope
xPCScopes.ScopeGetNumSamples	Get number of samples in one data acquisition cycle
xPCScopes.ScopeGetSignals	Get list of signals
xPCScopes.ScopeGetStartTime	Get last data acquisition cycle start time
xPCScopes.ScopeGetState	Get state of scope
xPCScopes.ScopeGetTriggerLevel	Get trigger level for scope
xPCScopes.ScopeGetTriggerMode	Get trigger mode for scope
xPCScopes.ScopeGetTriggerModeStr	Get trigger mode as string
xPCScopes.ScopeGetTriggerSample	Get sample number for triggering scope
xPCScopes.ScopeGetTriggerSignal	Get trigger signal for scope
xPCScopes.ScopeGetTriggerSlope	Get trigger slope for scope
xPCScopes.ScopeGetTriggerSlopeStr	Get trigger slope as string
xPCScopes.ScopeGetType	Get type of scope
xPCScopes.ScopeRemSignal	Remove signal from scope
xPCScopes.ScopeSetDecimation	Set decimation of scope
xPCScopes.ScopeSetNumPrePostSamples	Set number of pre- or posttriggering samples before triggering scope
xPCScopes.ScopeSetNumSamples	Set number of samples in one data acquisition cycle
xPCScopes.ScopeSetTriggerLevel	Set trigger level for scope
xPCScopes.ScopeSetTriggerMode	Set trigger mode of scope
xPCScopes.ScopeSetTriggerSample	Set sample number for triggering scope
xPCScopes.ScopeSetTriggerSignal	Select signal to trigger scope
xPCScopes.ScopeSetTriggerSlope	Set slope of signal that triggers scope
xPCScopes.ScopeSoftwareTrigger	Set software trigger of scope
xPCScopes.ScopeStart	Start data acquisition for scope
xPCScopes.ScopeStop	Stop data acquisition for scope
xPCScopes.TargetScopeGetGrid	Get status of grid line for particular scope
xPCScopes.TargetScopeGetMode	Get scope mode for displaying signals
xPCScopes.TargetScopeGetModeStr	Get scope mode string for displaying signals
xPCScopes.TargetScopeGetViewMode	Get view mode for target PC display
xPCScopes.TargetScopeGetYLimits	Get y-axis limits for scope
xPCScopes.TargetScopeSetGrid	Set grid mode for scope
xPCScopes.TargetScopeSetMode	Set display mode for scope
xPCScopes.TargetScopeSetViewMode	Set view mode for scope
xPCScopes.TargetScopeSetYLimits	Set y-axis limits for scope

Target Objects (xPCTarget)

xPCTarget.AverageTET	Get average task execution time
xPCTarget.GetAppName	Get target application name
xPCTarget.GetExecTime	Get execution time for target application
xPCTarget.GetNumOutputs	Get number of outputs
xPCTarget.GetNumParams	Get number of tunable parameters
xPCTarget.GetNumSignals	Get number of signals
xPCTarget.GetNumStates	Get number of states
xPCTarget.GetOutputLog	Copy output log data to array
xPCTarget.GetParam	Get parameter values
xPCTarget.GetParamDims	Get row and column dimensions of parameter
xPCTarget.GetParamIdx	Get parameter index
xPCTarget.GetParamName	Get parameter name
xPCTarget.GetSampleTime	Get sample time
xPCTarget.GetSignal	Get signal value
xPCTarget.GetSignalidsfromLabel	Get signal IDs from signal label
xPCTarget.GetSignalIdx	Get signal index
xPCTarget.GetSignalLabel	Get signal label
xPCTarget.GetSignalName	Copy signal name to character array
xPCTarget.GetSignalWidth	Get width of signal
xPCTarget.GetStateLog	Get state log
xPCTarget.GetStopTime	Get stop time
xPCTarget.GetTETLog	Get TET log
xPCTarget.GetTimeLog	Get time log
xPCTarget.GetxPCError	Get error string
xPCTarget.Init	Initialize target object to communicate with target PC
xPCTarget.IsAppRunning	Return running status for target application
xPCTarget.IsOverloaded	Return overload status for target PC
xPCTarget.isxPCError	Return error status
xPCTarget.LoadApp	Load target application onto target PC
xPCTarget.MaximumTET	Copy maximum task execution time to array
xPCTarget.MaxLogSamples	Return maximum number of samples that can be in log buffer
xPCTarget.MinimumTET	Copy minimum task execution time to array
xPCTarget.NumLogSamples	Return number of samples in log buffer
xPCTarget.NumLogWraps	Return number of times log buffer wraps
xPCTarget.SetParam	Change parameter value
xPCTarget.SetSampleTime	Change sample time for target application
xPCTarget.SetStopTime	Change stop time of target application
xPCTarget.StartApp	Start target application
xPCTarget.StopApp	Stop target application
xPCTarget.UnLoadApp	Unload target application

File System Objects (xPCFileSystem)

FSDir	Type definition for file system directory information structure
FSDiskInfo	Type definition for file system disk information structure
xPCFileSystem.CD	Change current directory on target PC to specified path
xPCFileSystem.CloseFile	Close file on target PC
xPCFileSystem.DirList	Return contents of target PC directory
xPCFileSystem.GetDiskInfo	Return disk information
xPCFileSystem.GetFileSize	Return size of file on target PC
xPCFileSystem.Init	Initialize file system object to communicate with target PC
xPCFileSystem.MKDIR	Create directory on target PC
xPCFileSystem.OpenFile	Open file on target PC
xPCFileSystem.PWD	Get current directory of target PC
xPCFileSystem.ReadFile	Read open file on target PC
xPCFileSystem.RemoveFile	Remove file from target PC
xPCFileSystem.RMDIR	Remove directory from target PC
xPCFileSystem.ScGetFileName	Get name of file for scope
xPCFileSystem.ScGetWriteMode	Get write mode of file for scope
xPCFileSystem.ScGetWriteSize	Get block write size of data chunks
xPCFileSystem.ScSetFileName	Specify file name to contain signal data
xPCFileSystem.ScSetWriteMode	Specify when file allocation table entry is updated
xPCFileSystem.ScSetWriteSize	Specify that memory buffer collect data in multiples of write size
xPCFileSystem.WriteFile	Write to file on target PC

xpcwwwenable

API Functions and Methods