beautypg.com

Obexclientget – Teledyne LeCroy BTTracer_Trainer - BTTrainer Users Manual User Manual

Page 238

background image

220

CATC BTT

RAINER

2.11

C

HAPTER

User’s Manual

Example

result = OBEXClientDisconnect();

OBEXClientGet

OBEXClientGet(RemotePath, LocalPath)

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)

Parameter

Meaning

Default Value

Comments

RemotePath

Path and name

of object to be
retrieved from

server.

Path is relative to server’s OBEX directory.
Example: If the OBEX directory is C:\temp, a
RemotePath of “file.txt” would cause the client
to retrieve “C:\temp\file.txt”

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.