Accessing Store Object Data

Functions

int SOMStoreGetStrParam (struct SOMSession *session, int paramtype, char *buffer, size_t buflen, size_t *paramlenp)
 Return an string-valued parameter from the store object. More...
 
int SOMStoreGetIntParam (struct SOMSession *session, int paramtype, int *valp)
 Return an integer-valued parameter from the store object. More...
 
int SOMStoreConnectionGetStrParam (struct SOMMSConnection *connection, int paramtype, char *buffer, size_t buflen, size_t *paramlenp)
 Return an string-valued parameter from the connection object. More...
 
int SOMStoreGetMailbox (struct SOMMSData *data, void **prev, char *buffer, size_t buflen, size_t *paramlenp)
 Return the next mailbox path from a data block. More...
 
int SOMStoreGetConnection (struct SOMMSData *data, void **prev, int *valp)
 Return the next connection id from a data block. More...
 
int SOMStoreGetMessage (struct SOMMSData *data, void **prev, char *buffer, size_t buflen, size_t *paramlenp)
 Return the next message path from a data block. More...
 
int SOMStoreConnectionGetIntParam (struct SOMMSConnection *con, int paramtype, int *valp)
 Return an integer-valued parameter from the connection object. More...
 
int SOMStoreMailboxGetStrParam (struct SOMMSMailbox *mbx, int paramtype, char *buffer, size_t buflen, size_t *paramlenp)
 Return an string-valued parameter from the mailbox object. More...
 
int SOMStoreMailboxGetIntParam (struct SOMMSMailbox *mbx, int paramtype, int *valp)
 Return an integer-valued parameter from the mailbox object. More...
 
int SOMStoreMessageGetStrParam (struct SOMMSMessage *message, int paramtype, char *buffer, size_t buflen, size_t *paramlenp)
 Return an string-valued parameter from the message object. More...
 
int SOMStoreMessageGetIntParam (struct SOMMSMessage *message, int paramtype, int *valp)
 Return an integer-valued parameter from the message object. More...
 

Detailed Description

Functions for accessing the attributes of store objects.

Function Documentation

◆ SOMStoreGetStrParam()

int SOMStoreGetStrParam ( struct SOMSession session,
int  paramtype,
char *  buffer,
size_t  buflen,
size_t *  paramlenp 
)

Return an string-valued parameter from the store object.

Parameters
session[in] Pointer to session object
paramtype[in] Type of parameter
buffer[in/out] address for result
buflen[in] length of buffer provided
paramlenp[out] Pointer to receive actual length
Returns
Zero on success or non-zero error code

◆ SOMStoreGetIntParam()

int SOMStoreGetIntParam ( struct SOMSession session,
int  paramtype,
int *  valp 
)

Return an integer-valued parameter from the store object.

Parameters
session[in] Pointer to session object
paramtype[in] Type of parameter
valp[out] Pointer to receive value
Returns
Zero on success or non-zero error code

◆ SOMStoreConnectionGetStrParam()

int SOMStoreConnectionGetStrParam ( struct SOMMSConnection *  connection,
int  paramtype,
char *  buffer,
size_t  buflen,
size_t *  paramlenp 
)

Return an string-valued parameter from the connection object.

Parameters
connection[in] Pointer to connection object
paramtype[in] Type of parameter
buffer[in/out] address for result
buflen[in] length of buffer provided
paramlenp[out] Pointer to receive actual length
Returns
Zero on success or non-zero error code

◆ SOMStoreGetMailbox()

int SOMStoreGetMailbox ( struct SOMMSData *  data,
void **  prev,
char *  buffer,
size_t  buflen,
size_t *  paramlenp 
)

Return the next mailbox path from a data block.

Parameters
data[in] Pointer to data block
prev[in] Handle to previous result (NULL on first call)
buffer[in/out] address for result
buflen[in] length of buffer provided
paramlenp[out] Pointer to receive actual length
Returns
Zero on success or non-zero error code

◆ SOMStoreGetConnection()

int SOMStoreGetConnection ( struct SOMMSData *  data,
void **  prev,
int *  valp 
)

Return the next connection id from a data block.

Parameters
data[in] Pointer to data block
prev[in] Handle to previous result (NULL on first call)
valp[out] Pointer to receive connection id
Returns
Zero on success or non-zero error code

◆ SOMStoreGetMessage()

int SOMStoreGetMessage ( struct SOMMSData *  data,
void **  prev,
char *  buffer,
size_t  buflen,
size_t *  paramlenp 
)

Return the next message path from a data block.

Parameters
data[in] Pointer to data block
prev[in] Handle to previous result (NULL on first call)
buffer[in/out] address for result
buflen[in] length of buffer provided
paramlenp[out] Pointer to receive actual length
Returns
Zero on success or non-zero error code

◆ SOMStoreConnectionGetIntParam()

int SOMStoreConnectionGetIntParam ( struct SOMMSConnection *  con,
int  paramtype,
int *  valp 
)

Return an integer-valued parameter from the connection object.

Parameters
con[in] Pointer to connection object
paramtype[in] Type of parameter
valp[out] Pointer to receive value
Returns
Zero on success or non-zero error code

◆ SOMStoreMailboxGetStrParam()

int SOMStoreMailboxGetStrParam ( struct SOMMSMailbox *  mbx,
int  paramtype,
char *  buffer,
size_t  buflen,
size_t *  paramlenp 
)

Return an string-valued parameter from the mailbox object.

Parameters
mbx[in] Pointer to mailbox object
paramtype[in] Type of parameter
buffer[in/out] address for result
buflen[in] length of buffer provided
paramlenp[out] Pointer to receive actual length
Returns
Zero on success or non-zero error code

◆ SOMStoreMailboxGetIntParam()

int SOMStoreMailboxGetIntParam ( struct SOMMSMailbox *  mbx,
int  paramtype,
int *  valp 
)

Return an integer-valued parameter from the mailbox object.

Parameters
mbx[in] Pointer to mailbox object
paramtype[in] Type of parameter
valp[out] Pointer to receive value
Returns
Zero on success or non-zero error code

◆ SOMStoreMessageGetStrParam()

int SOMStoreMessageGetStrParam ( struct SOMMSMessage *  message,
int  paramtype,
char *  buffer,
size_t  buflen,
size_t *  paramlenp 
)

Return an string-valued parameter from the message object.

Parameters
message[in] Pointer to message object
paramtype[in] Type of parameter
buffer[in/out] address for result
buflen[in] length of buffer provided
paramlenp[out] Pointer to receive actual length
Returns
Zero on success or non-zero error code

◆ SOMStoreMessageGetIntParam()

int SOMStoreMessageGetIntParam ( struct SOMMSMessage *  message,
int  paramtype,
int *  valp 
)

Return an integer-valued parameter from the message object.

Parameters
message[in] Pointer to message object
paramtype[in] Type of parameter
valp[out] Pointer to receive value
Returns
Zero on success or non-zero error code