FileName (RecordsetCursor function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Created page with "<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span> FileName property <p> <var>FileName</var> is a member of t...")
 
mNo edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
{{Template:RecordsetCursor:FileName subtitle}}
[[Category:RecordsetCursor methods|FileName property]]
<p>
<var>FileName</var> is a member of the <var>[[RecordsetCursor class|RecordsetCursor]]</var> class.
</p>


Returns the name of the file that contains the record at
the current cursor position.
==Syntax==
==Syntax==
<p class="syntax">%fname = %rscursor:FileName
{{Template:RecordsetCursor:FileName syntax}}
</p>
 
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%fname</th>
<tr><th>%string</th>
<td>A string to contain the name of the file of the current record.
<td>A string to contain the name of the file of the current record.
</td></tr>
</td></tr>
<tr><th>%rscursor</th>
<td>An instantiated <var>RecordsetCursor</var> object.


</td></tr></table>
<tr><th>recordsetCursor</th>
<td>A <var>RecordsetCursor</var> object.</td></tr>
</table>
 
==Usage Note==
==Usage Note==
<ul>
<ul>
Line 24: Line 19:
is <var>HasRecord</var>.
is <var>HasRecord</var>.
For more information about the state of the cursor,
For more information about the state of the cursor,
see [[RecordsetCursor#Cursor state|"Cursor state"]].
see [[RecordsetCursor class#Cursor state|"Cursor state"]].
</ul>
</ul>
==See also==
{{Template:RecordsetCursor:FileName footer}}

Latest revision as of 20:33, 12 November 2012

Return name of file containing the record at the current cursor position (RecordsetCursor class)


Syntax

%string = recordsetCursor:FileName

Syntax terms

%string A string to contain the name of the file of the current record.
recordsetCursor A RecordsetCursor object.

Usage Note

  • FileName is only valid if the cursor state is HasRecord. For more information about the state of the cursor, see "Cursor state".

See also