SwitchedOutputFileGetPathname method |
|
Remarks
Returns the absolute pathname of an output file switched through the SwitchOutputFile or the SwitchOutputFileEx methods during a recording session.
For further details about output files switching see the How to perform a recording session tutorial.
Syntax
[Visual Basic] Public Function SwitchedOutputFileGetPathname ( nFileId as Int32 ) as String |
[C#] public string SwitchedOutputFileGetPathname ( Int32 nFileId ); |
[C++] public: string SwitchedOutputFileGetPathname ( Int32 nFileId ); |
Parameter |
Description |
|
|
nFileId |
Number representing the zero-based index of the switched output file. This index is the same notified by the nData1 parameter of the CallbackForRecordersEvents delegate which is invoked with the nEvent parameter set to EV_REC_OUTPUT_FILE_SWITCH. |
Return value
Value |
Meaning |
|
|
Empty string |
The value of the nFileId parameter was out of range. Use the value returned by the SwitchedOutputFileGetCount method in order to know how many files have been switched. |
Valid string |
The string containing the absolute pathname of the switched output file. |