npFile plugin

npFileCreate

Create a new File object instance. You need to specify the file path to associate to the File object instance, the open mode and the share mode. The result variable store the ID of the File object instance, or "False" if an error ocurr. In this last case the [LastError] contain information about the error.

The open mode argument can be one of the following values:

• fmCreate Create a file with the given name. If a file with the given name exists, open the file in write mode.
• fmOpenRead Open the file for reading only.
• fmOpenWrite Open the file for writing only. Writing to the file completely replaces the current contents.
• fmOpenReadWrite Open the file to modify the current contents rather than replace them.

The share mode argument can be one of the following values:

• fmShareCompat Sharing is compatible with the way are opened (by default).
• fmShareExclusive Other applications can not open the file for any reason.
• fmShareDenyWrite Other applications can open the file for reading but not for writing.
• fmShareDenyRead Other applications can open the file for writing but not for reading.
• fmShareDenyNone No attempt is made to prevent other applications from reading from or writing to the file (by default).

↑↑

npFileDestroy

Destroy a previosly created File object instance. Specify the File object instance ID in order to free from the memory. This action also "close" the file handle, opened when create the File object instance. The result variable store "True" if everything is OK, or "False" if an error ocurr. In this last case the [LastError] contain information about the error.

↑↑

npFileDestroyAll

Destroy all previosly created File object instances.

↑↑

npFileRead

Read the count of bytes from the current cursor file position in a File object instance. Use this action to read data from the File object instance. Read transfers up to Count bytes from the stream, starting at the current position, and then advances the current position in the stream by the number of bytes actually transferred.

The Bytes Transferred variable store the number of bytes actually transferred, which may be less than Count if the end of file marker is encountered. The result variable store the content readed from the file stream or "False" if an error ocurr. In this last case the [LastError] contain information about the error.

↑↑

npFileWrite

Write content to a previously created File object instance. Use this action to write data to the File object instance, starting at the current position. After writing to the stream, this action advances the current stream position by the number of bytes written. The result variable store the number of bytes writen or "False" if an error ocurr. In this last case the [LastError] contain information about the error.

↑↑

npFileSeek

Move the current stream position of a File object instance. Use this action to move the indicated offset the current position within the stream associated with the specified File object instance. This allows an application to read from or write to a particular location within the File. The Origin argument indicates how to interpret the Offset argument. Origin should be one of the following values:

• soFromBeginning Offset is from the beginning of the stream. Seek moves to the position Offset. Offset must be >= 0.
• soFromCurrent Offset is from the current position in the stream. Seek moves to Position + Offset.
• soFromEnd Offset is from the end of the stream. Offset must be <= 0 to indicate a number of bytes before the end of the file.

The result variable store the new value of the stream position, the new current position in the stream or "False" if an error ocurr. In this last case the [LastError] contain information about the error. See also npFileSetPos.

↑↑

npFileGetPos

Get the current stream position of a File object instance. The result variable store the current stream position of the specified File object instance or "False" if an error ocurr. In this last case the [LastError] contain information about the error.

↑↑

npFileSetPos

Set the current stream position of a File object instance. The result variable store the new position of the stream in the specified File object instance or "False" if an error ocurr. In this last case the [LastError] contain information about the error. See also npFileSeek.

↑↑

npFilePath

Get the file path associated with the specified File object instance. Remember you need to indicate a file path when you create a new File object instance. This action allow you to retrieve this path in the result variable, which can contain "False" if an error ocurr. In this last case the [LastError] contain information about the error.

↑↑

npFileBytes

Get the file bytes (size) associated with the specified File object instance. The result variable store the size in bytes of the current File object instance or "False" if an error ocurr. In this last case the [LastError] contain information about the error.

↑↑

Action errors subroutine

All the NeoPlugins deal with errors in the same way that NeoBook does: when the plugin found an action error the [LastError] variable store information about the error, so you can take care about this variable when execute an action.

But all the NeoPlugins also incorporate an advanced way to deal with possible action errors. You can define a subroutine named OnNeoPluginActionError in order to be executed when some action error are found and you can use this variables inside:

• [LastError] The last action error message.
• [PluginName] Store the plugin name which cause the error.

Note that this error handling subroutine are shared for all the NeoPlugins, so you no need to specify a subroutine for every plugin you use in your publication because the same subroutine are recognized and automagically used by every NeoPlugin. Below you can view a sample of this subroutine code:

:OnNeoPluginActionError
  AlertBox "NeoPlugin Error" "Error [LastError] in plugin: [PluginName]"
Return

Also note that the use of this NeoPlugins error handling subroutine is completelly optional. You can continue using the [LastError] variable as usual and even use the both methods at the same time.

↑↑