GET_LOID(OC)

Shore Programmer's Manual - 3 November 94

NAME

get_loid \- convert ref to logical oid

SYNOPSIS

#include <ShoreApp.h>
shrc REF(T)::get_loid(LOID &loid) const;
shrc REF(T)::get_primary_volid(VolId &volid) const;

DESCRIPTION

Get_loid retrieves the logical OID (LOID) corresponding to the given ref and stores it into loid. If the ref is nil, then the nil LOID (LOID::null) is retrieved. If the ref is invalid because its target was previously deleted, then no error will be signalled, but the retrieved LOID will be equivalently invalid.

Get_primary_volid stores the id of the volume on which the referenced object resides into volid. If the ref is nil, then the nil VolId (VolId::null) is returned. If the ref is invalid because its target was previously deleted, then the returned VolId will be that of the volume on which it used to reside.

An object's LOID can also be retrieved via Shore::stat (see stat(oc) ) or REF(T)::ostat (see ostat(oc) ), both of which return other information about the object in addition to its LOID. If only the LOID (VolId) is desired, then get_loid (get_primary_volid) is preferable to Shore::stat or REF(T)::ostat, as it usually does not require communication with the Shore server, where the two stat methods always communicate with the server.

BUGS

The current release of the Shore server does not support more than a single mounted volume. Therefore, get_primary_volid will always return that volume's id or the nil VolId.

VERSION

This manual page applies to Version 0.1 of theShore software.

SPONSORSHIP

The Shore project is sponsored by the Advanced Research Project Agency, ARPA order number 018 (formerly 8230), monitored by the U.S. Army Research Laboratory under contract DAAB07-91-C-Q518.