hwISession GetDataFileHandle

Returns the data file interface object for a given file.

Syntax

hwISession_handle GetDataFileHandle filehandle, datafile

Application

HyperWorks Tcl Query

Description

You need to load a data file (for example, test.dat) in the path specifed before you can get a handle with the above arguments.

Inputs

filehandle: The user-defined name of the file handle that you want to create with this command. In the examples below, the file handle is "ABC".
datafile: This argument can be of two types:; A variable name that contains the address of the data file that you want to read.; The full path of the data file enclosed within double quotes.

Example

set FileName "D:/temp/test.dat"
hwi GetSessionHandle sessHandle
sessHandle GetDataFileHandle ABC $FileName
Returns: ABC

hwi GetSessionHandle sessHandle
sessHandle GetDataFileHandle ABC "D:/temp/test.dat"
Returns: ABC

Errors

Returns the file handle name if successful.

Returns an error message if the command fails.