mmo-ref/polserver
1
0
Fork 0
mirror of https://github.com/polserver/polserver synced 2026-08-13 08:23:08 -04:00
Code Issues Projects Releases Packages Wiki Activity
polserver/docs/docs.polserver.com/pol100/datafileem.xml

63 lines
3 KiB
XML
Raw Permalink Normal View History

pol99 docs, online version (will) use this via cronjob
2012-01-04 07:18:26 +00:00
<?xml version='1.0' encoding="iso-8859-1"?>
<?xml-stylesheet type="text/xsl" href="escript.xslt" ?>
<!DOCTYPE ESCRIPT SYSTEM "escript.dtd">
<ESCRIPT>
<fileheader fname="Datafile.em">
<filedesc>Functions to access generic data files.</filedesc>
<datemodified>10/27/2007</datemodified>
<constant>// OpenDataFile flags:</constant>
<constant>// can specify only one of the following:</constant>
<constant>const DF_KEYTYPE_STRING := 0x00; // default</constant>
<constant>const DF_KEYTYPE_INTEGER := 0x01;</constant>
</fileheader>
Documentation: sync EScript Modules documentation with em files Also added a new tool checkem.py in "doctools" folder: it helps checking wether em and xml files are in sync or no. This is a quite accurate job: I'm almost 100% sure (thanks to checkem.py) that: - All the functions defined in .em files are now mentioned in docs (except of deprecated ones that i omitted on purpose) - Function prototypes are the same in .em files and their doc - All the function arguments have at least a basic doc element - All the constants defined in .em files are in the docs A 2nd round of review would be probably useful tought, expecially on uoem.xml, who had the major changes: I didn't go deep into what every function does and maybe some slightly changed their behaviour during these years. This should be a more than good start anyway: if there are some errors left, hope somebody will notice and report them :)
2015-09-02 03:06:36 +02:00
pol99 docs, online version (will) use this via cronjob
2012-01-04 07:18:26 +00:00
<function name="CreateDataFile">
<prototype>CreateDataFile( filespec, flags := DF_KEYTYPE_STRING )</prototype>
<parameter name="filespec" value="String" />
<parameter name="flags" value="Integer" />
<explain>Creates a new data file.</explain>
<explain>filespec is in normal package descriptor format. 'filename' or '::filename' will create the new data file /data/ds/filename. ':pkgname:filename' will create /data/ds/pkgname/filename.</explain>
<explain>flags specifies if the keys of the new datafile are strings OR integers.</explain>
<return>DataFile Reference. See the DataFile object documentation.</return>
<error>"Error in descriptor"</error>
<error>"An exception occurred"</error>
<error>"Invalid parameter type"</error>
<related>Datafile</related>
</function>
<function name="OpenDataFile">
<prototype>OpenDataFile( filespec )</prototype>
<parameter name="filespec" value="String" />
<explain>Opens a datafile for access.</explain>
<explain>filespec is in normal package descriptor format. 'filename' or '::filename' will open the data file /data/ds/filename. ':pkgname:filename' will open /data/ds/pkgname/filename.</explain>
<return>DataFile Reference. See the DataFile object documentation.</return>
<error>"Datafile does not exist"</error>
<error>"Error in descriptor"</error>
<error>"An exception occurred"</error>
<error>"Invalid parameter type"</error>
<related>Datafile</related>
</function>
Documentation: sync EScript Modules documentation with em files Also added a new tool checkem.py in "doctools" folder: it helps checking wether em and xml files are in sync or no. This is a quite accurate job: I'm almost 100% sure (thanks to checkem.py) that: - All the functions defined in .em files are now mentioned in docs (except of deprecated ones that i omitted on purpose) - Function prototypes are the same in .em files and their doc - All the function arguments have at least a basic doc element - All the constants defined in .em files are in the docs A 2nd round of review would be probably useful tought, expecially on uoem.xml, who had the major changes: I didn't go deep into what every function does and maybe some slightly changed their behaviour during these years. This should be a more than good start anyway: if there are some errors left, hope somebody will notice and report them :)
2015-09-02 03:06:36 +02:00
pol99 docs, online version (will) use this via cronjob
2012-01-04 07:18:26 +00:00
<function name="UnloadDataFile">
<prototype>UnloadDataFile( filespec )</prototype>
<parameter name="filespec" value="String" />
<explain>Unloads a datafile</explain>
<explain>filespec is in normal package descriptor format. 'filename' or '::filename' will unload the data file /data/ds/filename. ':pkgname:filename' will unload /data/ds/pkgname/filename.</explain>
<return>1 on success</return>
<error>"Unable to find data store file"</error>
<error>"Invalid parameter type"</error>
<related>Datafile</related>
</function>
<function name="ListDataFiles">
<prototype>ListDataFiles( )</prototype>
<explain>Returns an array of structs containing: </explain>
<explain>.pkg - name of the package the datafile belongs to</explain>
<explain>.name - name of the file</explain>
<explain>.descriptor - :pkg:name</explain>
<return>Array of Structs</return>
<related>Datafile</related>
</function>
</ESCRIPT>
Reference in a new issue Copy permalink