Teledyne LeCroy Merlins Wand - Users Manual - Manual (Page 231)

215
CATC M ERLIN ’ S W AND 2.00 C HAPTER C
User’s Manual Merlin’s Wand Scripting Commands
Return value
• “Success”
• “Failure”
• “Failed: Busy”
• “Failed: Not connected”
• “Failed: Packet too small”
• “Failed: Invalid handle”
Comments
Retrieves object from a server and saves it to the client.
If directory names are included in either path argument, be sure to use
double-slashes to separate components (e.g., “temp1\\temp2\\file-
name.txt”). Using single slashes will cause errors.
Note that the second argument may be omitted, in which case the object
will be stored to the client’s OBEX directory with the same name it has on
the server.
Examples
In these examples, the local OBEX directory is assumed to be c:\obexdir.
#store file to "file.txt" in local OBEX directory
# (i.e., c:\obexdir\file.txt)
OBEXClientGet("file.txt");
#store file to "newfile.txt" in temp dir under OBEX dir
# (i.e., c:\obexdir\temp\newfile.txt)
OBEXClientGet("file.txt", "temp\\newfile.txt");
#store file to "file.txt" in C:\temp
OBEXClientGet("file.txt", "C:\\temp\\file.txt");
#get file from a directory below the server’s OBEX dir,
# and save it with the same name to the same directory
LocalPath Path and name
of object to be
created on cli-
ent.
RemotePath
argument
If omitted, object will be stored to the local
OBEX directory with the name it has on the
server.
If specified as a relative path (i.e., without a drive
letter), the path will be considered relative to the
OBEX directory.
If specified as a full path (i.e., with a drive letter),
the object will be stored to the exact name and
path specified.
Parameter Meaning Default Value Comments