|
Using the LDFILES macroLoading a file into memory from a macro is a very common thing to do. In the CMACWIN reference we have a note on the LOAD_FILE function. It begins: "NOTE: We recommend the use of the LDFILES macro in the macro file MESYS instead of using the LOAD_FILE operation." Unfortunately, we don't give you much more info than that. This document will show you how to make effective use of the LDFILES macro. This LDFILES macro has been around since the early days of the DOS version of Multi-Edit, and still uses the command-line style of parameter passing. The LOAD_FILE internal function is very primitive: it simply loads a file into a window. It doesn't do any configuration for the file, it doesn't set the tabs, or any of the other filename extension specific configuration items, and it can't handle creating windows or loading multiple files. LDFILES was created to handle all of these things and more. It can find a file on the path when no directory is specified. It will load multiple files and create new windows. It calls the macro EXT_SETUP to process extensions specific configuration. NOTE: There are times when LOAD_FILE is appropriate. If you are loading a temporary file, or any file that will not be displayed, than LOAD_FILE may make more sense than LDFILES. Why go through all the extra processing if it isn't needed? The basic use of LDFILES is simple: You put the name of the file you want to load in Return_Str, and then perform a RM("LDFILES"). Normally you will also have to pass some parameters to LDFILES, and we will go into those. The number of files loaded is returned in Return_Int, however, Return_Int is always at least 1. To check the success of the operation, use Error_Level. If Error_Level is non-zero, then an error occurred. A complete description of the parameters and return values follows the examples. Example 1 - Load a file into the current window, check for error
Return_Str = "C:\TEST.TXT";
RM("LDFILES");
if(Error_Level)
{
// Process errors here. If we don't process the error, then
// the default error dialog will be popped up after this
// macro is exited. If we do process the error, then we
// need to be sure to set Error_Level back to zero.
}
Example 2 - Load a file into a new window.
Return_Str = "C:\TEST.TXT";
RM("LDFILES /CW=1");
if(Error_Level)
{
// Process errors here.
}
Example 3 - Load multiple files with a wildcard. Only load the first
one into a new window if the current window is NOT empty.
When done, switch back to the window we started in.
int OriginalWindow = Window_Id;
Return_Str = "*.TXT";
RM("LDFILES /CW=2");
// The current window is not necessarily the one we started with
Switch_Win_Id( OriginalWindow );
// Now process errors, etc.
Example 4 - Load multiple files from a file list. This one will
be a complete macro. The file list would look like this:
c:\test\wow.txt
c:\what\something.s
d:\where\more.c
....
NOTE: You can use the /FTO= parameter in the file list itself to
override the file types of specific files. For example:
/FTO=2 c:\test\wow.txt
int LoadFilesFromList( str ListFileName = mparm_str )
// Allow the list file to passed on the command line
// Return TRUE (non-zero) if the function succeeds.
{
int Result = FALSE;
int OrigRefresh = Refresh; // Save the refresh
refresh = FALSE; // and disable it
int OrigWindow = Window_Id; // Save off the original window id
Error_Level = 0; // Clear Error_Level in case it was
// not previously cleaned up
Create_Window; // Create a temporary window to
// load our list file into
int ListWindow = Window_Id; // Store the id of our list file window
Load_File( ListFileName ); // Load the list file
if(!Error_Level) // If no error, load the files in
{ // the list. Always create new
// window. Pass the Window_Id of the
// list window using /TAG=
RM("LDFILES /CW=1/TAG=" + str(Window_Id));
if(!Error_Level) // If no error occurred, then reset
{ // OrigWindow, so that we stay in
OrigWindow = Window_Id; // the window of the first file loaded
Result = TRUE; // We have succeeded!
}
}
// Switch back to our list window
// Remember, the current window may
Switch_Win_Id( ListWindow ); // have changed during the LDFILES
Delete_Window; // Destroy the list window
Switch_Win_Id( OrigWindow ); // Switch back to the original window
// or the first loaded file (if the
// LDFILES succeeded)
Refresh = OrigRefresh; // Restore refresh
return( Result );
}
LDFILES documentationParameters: Return_Str = the filename;
Returns: Also, Global integer Load_Count will be set to /LC=nn + the number of files loaded.
|
Subscribe to the Multi-Edit Newsletter:
Click here
SAS is a registered trademark of SAS Institute Inc. in the USA and other countries.
Home - News - Products - Support - Purchase - Resources - Company - Sitemap |
|
Please review our MESI Privacy Policy: