Zen API | Contents | Reference | Previous | Up | Next

zFireSync functions
Functions zFireSync

zFireSync member functions.

Functions

Function | Description
zFireSync_Backup | Creates a backup of FireSync server files that can later be restored.
zFireSync_BeginCommand | Begins formatting a custom command.
zFireSync_BeginUpgrade | Initiates a firmware upgrade for devices in the FireSync network.
zFireSync_Connect | Connects to a FireSync server on the Upgrade, Management, and/or Control channels.
zFireSync_Construct | Constructs a zFireSync object.
zFireSync_CopyFile | Copies the specified file within a FireSync server.
zFireSync_DeleteFile | Deletes the specified file from FireSync server.
zFireSync_Destroy | Destroys a zFireSync object.
zFireSync_DisableData | Disables an active or passive FireSync server data channel.
zFireSync_Disconnect | Closes one or more open control channels to a FireSync server.
zFireSync_Discover | Locates unknown FireSync servers and reports their network address settings.
zFireSync_EnableActiveData | Enables a FireSync server active data channel and associates the data channel with the specified destination.
zFireSync_EnablePassiveData | Enables a FireSync server passive data channel and provides the end-point to which a receiver can connect.
zFireSync_Enumerate | Retrieves a list of serial numbers describing the sensor, master, and station devices in the network.
zFireSync_FileCount | Reports the number of files available from the FireSync server.
zFireSync_FileNameAt | Gets the name of the file at the specified index.
zFireSync_GetAddress | Locates a FireSync server by id (serial number) and reports its network address settings.
zFireSync_GetClientVersion | Gets the latest version of FireSync Host Protocol that is supported by this library.
zFireSync_GetDeviceInfo | Accesses information about a particular device in the FireSync network (sensor, master, station).
zFireSync_GetEncoder | Gets the current encoder value.
zFireSync_GetHealthLog | Gets the health log from a FireSync server.
zFireSync_GetMode | Gets the current mode of the system.
zFireSync_GetParameter | Gets the value of a dynamic parameter associated with the specified mode.
zFireSync_GetProcessLog | Gets the process log from a FireSync server.
zFireSync_GetServerVersion | Gets the version of FireSync Host Protocol implemented by a FireSync server control channel.
zFireSync_GetStartDelay | Gets the maximum time (in microseconds) required to process a Start command.
zFireSync_GetTime | Gets the elapsed time since power was applied to the server.
zFireSync_GetUpgradeLog | In the event of an upgrade failure, this function can be used to retrieve a server log file.
zFireSync_GetUpgradeStatus | Reports the current status of a FireSync firmware upgrade process.
zFireSync_IsConnected | Determines whether a connection has been established on the specified channel.
zFireSync_LocalEndPoint | Gets the local end point to which the specified channel is bound.
zFireSync_PassiveEventEndPoint | Returns the IP end point for passive event connections.
zFireSync_PassiveHealthEndPoint | Returns the IP end point for passive health connections.
zFireSync_Pause | Commands FireSync server to pause system execution.
zFireSync_Ping | Checks that FireSync server is responsive, and optionally enables server ping monitoring.
zFireSync_ReadFile | Reads the specified file from FireSync server.
zFireSync_RemoteEndPoint | Gets the remote end point to which the specified channel is connected.
zFireSync_ResetEncoder | Resets the current encoder value to 0.
zFireSync_Restore | Restores a backup of FireSync server files.
zFireSync_Resume | Commands FireSync server to resume system execution.
zFireSync_ScheduleStart | Commands one or more FireSync servers to start at the specified time or position.
zFireSync_SendCommand | Sends a custom command and receives the response.
zFireSync_SetAddress | Locates a FireSync server by id (serial number) and configures its network address settings.
zFireSync_SetMode | Sets the current mode of the system.
zFireSync_SetParameter | Sets the value of a dynamic parameter associated with the specified mode.
zFireSync_Start | Commands FireSync server to start the system.
zFireSync_StartActiveEvents | Commands FireSync server to begin sending event messages to specified receiver.
zFireSync_StartActiveHealth | Commands FireSync server to begin sending health messages to specified receiver.
zFireSync_Stop | Commands FireSync server to stop the system.
zFireSync_StopActiveEvents | Commands FireSync server to close the event connection, if currenly open.
zFireSync_StopActiveHealth | Commands FireSync server to close the health connection, if currenly open.
zFireSync_WriteFile | Saves the given file on FireSync server.

Copyright (c) 2008-2010 by LMI Technologies Inc. All rights reserved.
Contents | Reference