BACKUP object


Functions

bool isBAK (SatAddr src)
 is the object at src a BACKUP?
int BAKnibbles (SatAddr src)
 Return the size in nibbles of the BACKUP at src.
int BAKnameLen (SatAddr src)
 Get the number of characters in a BACKUP's name.
bool BAKdecode (SatAddr src, char *name, SatAddr *obj, SatAddr *crc)
 Decode a BACKUP object.

Detailed Description

I've included code for BACKUP objects, but I'm not sure how to access a BACKUP so I haven't been able to test these. USE AT YOUR OWN RISK.

I don't know how to create the CRC for a BACKUP object so there are currently no methods to create them.


Function Documentation

bool BAKdecode ( SatAddr  src,
char *  name,
SatAddr obj,
SatAddr crc 
)

Decode a BACKUP object.

Parameters:
src Saturn address of a BACKUP object.
name If non-null, then the BACKUP's name will be stored here as a null-terminated string. In this case "name" must point to sufficient space for the name and the null terminator. 256 bytes is always enough. BAKnameLen(src)+1 is exactly the right size.
obj If non-null then the Saturn address of the object in the backup will be put here.
crc. If non-null then the address of the backup's CRC will be put here. The CRC is BINT object.
Returns:
true on success, false if src isn't a BACKUP object or another error occurs.

int BAKnameLen ( SatAddr  src  ) 

Get the number of characters in a BACKUP's name.

Parameters:
src Saturn address of a BACKUP object.
Returns:
The number of characters in the BACKUP's name, or -1 if "src" isn't a BACKUP object

int BAKnibbles ( SatAddr  src  ) 

Return the size in nibbles of the BACKUP at src.

Parameters:
src the Saturn address of a BACKUP object
Returns:
the size of the BACKUP in nibbles, or zero if src is not a BACKUP

bool isBAK ( SatAddr  src  ) 

is the object at src a BACKUP?

Parameters:
src Saturn address of an object
Returns:
true if the object at src is a BACKUP.


Generated on Sat Apr 3 16:38:31 2010 for HPObjects by  doxygen 1.5.0