cwbDQ_GetForceToStorage

Purpose

Get the attribute for whether records will be forced to auxiliary storage when they are enqueued.

Syntax

 
unsigned int CWB_ENTRY cwbDQ_GetForceToStorage(
                             cwbDQ_Attr          queueAttributes,
                             cwb_Boolean        *forceToStorage);

Parameters

cwbDQ_Attr queueAttributes - input
Handle of the data queue attributes returned by a previous call to cwbDQ_CreateAttr.
cwb_Boolean * forceToStorage - output
Pointer to a Boolean where the force-to-storage indicator will be written.

Return Codes

The following list shows common return values.

CWB_OK
Successful completion.
CWB_INVALID_POINTER
Bad or null pointer.
CWBDQ_INVALID_ATTRIBUTE_HANDLE
Invalid attributes handle.

Usage

None