WinAPI, RPC 1702 and FindFirstFileW

April 8, 2009 at 23:39
filed under Dynamics AX
Tagged , , ,

A very common scenario when doing interfaces with other applications, is to have a directory where one application places files, and the other one picks those up and processes them.
Let’s say some application want to interface with Dynamics AX, one way, from that application to AX. That application will drop files of a specific format, say *.txt, in a directory. You’ll want to have a batch job in AX that checks that directory every 5 minutes for those files. When your batch job finds those files, it will open them and do something with that data, then move them to an other directory, so you don’t process them twice.

Now the first thing you’ll probably think of (well, I did…), is to use the class WinAPI. This class has some useful static methods for checking if folders or files exist, finding files with a filename of a certain format. Just the kind of thing we’re looking for. Your code might look like this:

static void loopfilesWinApi(Args _args)
{
    str fileName;
    int handle;
    str format = "*.txt";
    ;

    if(WinApi::folderExists("C:\\Temp\\"))
    {
        [handle,fileName] = WinApi::findFirstFile("C:\\Temp\\" + format);
        while(fileName)
        {
            //currentfileName = fileName;
            info(filename);
            filename = WinApi::findNextFile(handle);
        }
        WinApi::closeHandle(handle);
    }
}

That’s perfect. It checks a directory, in this cas C:\temp, for files with the extension txt… until you try to run this in batch. Your batch will have the status error, and there will be an entry in the event log saying:

RPC error: RPC exception 1702 occurred in session xxx

That error message is very misleading, but Florian Dittgen has a nice blog entry about this, that explains why this goes wrong: WinAPI methods a static and run on client. In batch, you can not use these client methods.
But hey! There is a class called WinAPIServer, surely this runs on server, right? Correct, but a lot of the methods available in WinAPI are missing in WinAPIServer. You can however extend the WinAPI server class by copying methods from the WinAPI class and modifying them a bit. Let’s try that.

This is what the WinAPI::FindFirstFile() method looks like:

client static container findFirstFile(str filename)
{
    Binary data = new Binary(592); // size of WIN32_FIND_DATA when sizeof(TCHAR)==2
    DLL _winApiDLL = new DLL(#KernelDLL);
    DLLFunction _findFirstFile = new DLLFunction(_winApiDLL, 'FindFirstFileW');

    _findFirstFile.returns(ExtTypes::DWord);

    _findFirstFile.arg(ExtTypes::WString,ExtTypes::Pointer);

    return [_findFirstFile.call(filename, data),data.wString(#offset44)];
}

As you can see, this method uses the function FindFirstFileW from the Kernel32 dll located in the folder C:\WINDOWS\system32. Let’s copy this method to WinAPIServer and modify it to look like this:

server static container findFirstFile(str filename)
{
    #define.KernelDLL('KERNEL32')
    #define.offset44(44)

    InteropPermission interopPerm;
    Binary data;
    DLL _winApiDLL;
    DLLFunction _findFirstFile;
    ;

    interopPerm = new InteropPermission(InteropKind::DllInterop);
    interopPerm.assert();

    data = new Binary(592); // size of WIN32_FIND_DATA when sizeof(TCHAR)==2
    _winApiDLL = new DLL(#KernelDLL);
    _findFirstFile = new DLLFunction(_winApiDLL, 'FindFirstFileW');

    _findFirstFile.returns(ExtTypes::DWord);

    _findFirstFile.arg(ExtTypes::WString,ExtTypes::Pointer);

    return [_findFirstFile.call(filename, data),data.wString(#offset44)];
}

Three things have changed here:

  1. “Client” has been change to “Server” so it can run on server;
  2. The code has been changed to use the InteropPermission class; this is required because the code runs on server;
  3. Initialization of the variables is moved to after assertion of the InteropPermission.

When you test this in batch (running on server), this will work, and you can do this for all WinAPI methods in the examples above… until you try this on a x64 architecture. You’ll receive a message saying that an error occurred when calling the FindFirstFileW function in the Kernel32 DLL (the exact message slipped my mind).
The problem is described on the Axapta Programming Newsgroup. You can code your way around this problem, but I think the message is clear: don’t use WinAPI.

Instead, use the .NET Framework System.IO namespace (watch out for lowercase/uppercase here), in our case in specific, System.IO.File and System.IO.Directory.
I get this nice code example from Greg Pierce’s blog (modified it a bit):

static void loopfilesSystemIO(Args _args)
{
    // loop all files that fit the required format
    str fileName;
    InteropPermission interopPerm;

    System.Array files;
    int i, j;
    container fList;
    ;

    interopPerm = new InteropPermission(InteropKind::ClrInterop);
    interopPerm.assert();

    files = System.IO.Directory::GetFiles(@"C:\temp", "*.txt");
    for( i=0; i<ClrInterop::getAnyTypeForObject(files.get_Length()); i++ )
    {
        fList = conins(fList, conlen(fList)+1, ClrInterop::getAnyTypeForObject(files.GetValue(i)));
    }

    for(j=1;j&lt;= conlen(fList); j++)
    {
        fileName = conpeek(fList, j);
        info(fileName);
    }
}

This will run on client and on server without any problems. To have clean code, you could create your own class, just like WinAPI, but using the System.IO namespace. That way, you can reuse this code and save time.

Conclusion: abandon WinAPI, and use System.IO instead.

11 comments

RSS / trackback

  1. Jeroen Doens

    Nice research!

  2. Amber

    How do you then move them into another directory to avoid processing the same files the next time the batch runs?

    Thanks!

  3. Klaas Deforche

    You can use this method:

    server static void moveFile(str fileName, str newFileName)
    {
        #File
        Set                 permissionSet;
        ;

        permissionSet =  new Set(Types::Class);
        permissionSet.add(new FileIOPermission(fileName,#io_write));
        permissionSet.add(new InteropPermission(InteropKind::ClrInterop));

        CodeAccessPermission::assertMultiple(permissionSet);

        System.IO.File::Move(fileName, newFileName);

        CodeAccessPermission::revertAssert();
    }

    Let me know if it works or if you need more help.

  4. Rob

    Hi there!

    I’m creating an interface between Dax and another app just the way described by using textfiles in a folder. Everything works fine, only I have one problem: the exportscript from app1 (Oracle app) and the DAX importscript are executed asynchronic. Things go wrong when app 1 hasn’t finished writing the exportfile and Dax already starts importing the file.

    I there a way to determine the filesize? So I can import only when the filesize > 0 kb. I tried WinAPI::filesize but it always returns 0.

    Thanx!

    Rob

  5. Klaas Deforche

    Hi Rob,

    I’m familiar with the problem, but it’s a tricky one.
    If you are looking to determine the file size, this should return the file size in bytes:

    info(strfmt("%1", WinAPI::filesize(@"C:\testing.txt")));

    I don’t know if that’s a good way to check if the process has finished writing the file, because the size could be greater than 0, even if the process hasn’t finished writing (for example when it is appending information to the file).

    Here’s a few alternative ways to deal with this:
    1. The Oracle app create the file in a temporary directory, and when it’s finished, it moves the file to the directory you are monitoring in AX.

    2. Or the Oracle app creates the file with a filename or extension you are not monitoring, and renames it to the correct file name when it’s finished (my favourite).

    3. Or the Oracle app create a second file when it has finished writing, with the same filename, but a different extension (eg: filename.csv and filename.done), and you only read files that have a corresponding .done file (check this in AX).

    Hope this helps!

  6. Michael

    When using the code in #3 above I get the following error:

    ClrObject static method invocation error.

    Anyone have ideas on what to check as to the cause of this error?

  7. Klaas Deforche

    Hi Michael,

    I’ve had this problem as well, especially when executing code in batch.

    It probably has something to do with escaping the slashes in your string.
    Try this:

    System.IO.File::Move(strfmt(@"%1", fileName), strfmt(@"%1", newFileName));

    Also, using FileName as datatype for you parameters in stead of str might do the trick.
    Let us know what works for you.

  8. Michael

    Thanks for the quick response. I ended up adding a try/catch to pull in the modt recent message and it told me that the file was still in use which pointed me to the fact that I had not closed the file (i.e. set it to NULL) before trying to move it. So once I did that it worked fine.

    Thanks so much for this blog post – it saved me huge amounts of time.

  9. Jan VO

    Thanks for the tips regarding escaping slashes, it works .

  10. John

    I am using System.IO.File::Exists method to check a file and if it exists create a new file with a different name. Problem is when i call this code using a batch server getting error:

    permissionSet = new Set(Types::Class);
    permissionSet.add(new FileIOPermission(successDirectory + filename, #io_read));
    CodeAccessPermission::assertMultiple(permissionSet);

    Request for the permission of type ‘InteropPermission’ failed.
    (S)\Classes\InteropPermission\demand
    (S)\Classes\CLRInterop\staticInvoke
    (S)\Classes\SIG_AIInboundController\run – line 190
    (S)\Classes\BatchRun\runJobStatic – line 62

    Can you think of any idea why this is happening

    //w_OrigfilenameFilename = filename;
    if (!System.IO.File::Exists(successDirectory + filename))

  11. Klaas Deforche

    Hi John,

    I believe the problem is that you didn’t add the InteropPermission to your set of permissions.

    Please add the following line (before CodeAccessPermission::assertMultiple()) and try again:

    permissionSet.add(new InteropPermission(InteropKind::ClrInterop));

    You need the ClrInterop permission to use this function:
    System.IO.File::Exists().

    Hope this helps.

respond