CacheSampleNumber

Cache, Sample Numbers

Minor Business Rule

Object Name: B3700410

Parent DLL: CMFG

Location: Client/Server

Language: C


1.Functional Description


1.1Purpose

The purpose of this function will be to setup and manage a cache to store test sample numbers (SNBR).  This function is called from with-in the F3711 

Test Results MBF.


1.2Setup Notes and Prerequisites

N/A


1.3Special Logic

N/A


2.Technical Specifications


2.4Processing 


I.Initialize cache by removing from memory (Process Mode - 8).
II.Load Cache (Process Mode - 2,7)

III.Get cache record, w/ or w/o cache key (Process Mode - 1).

IV.Get next cache record if iterating in a looping structure (Process Mode - 6).

V.Remove cache from memory (Process Mode - 8).

VI.If any errors are encountered set error and return, unless suppress error message flag is set then don't set error and return.


2.5Calling Applications 

This function will be used by applications needing to maintain a cache for system sample numbering.


1.F3711 Test Results MBF  - N3700150

Data Structure

D3700410 - Cache, Sample Numbers

SNBR       mnSampleCounter_SNBR    IY
SNBR       mnSampleNumber_SNBR    I/ON

INT01       nNumberOfKeys_INT01    IN

EV01       cProcessMode_EV01                    IN1-Get First, 2-Add, 3-Update, 4-Delete, 

                                                                                                                5-Delete All, 6-Get Next, 7-Add Update, 

                                                                                                                8-Terminate Cache, 9-Close Cursor.

EV01        cCacheCodeError_EV01    ON

EV01        cSuppressErrorMsgs_EV01    IN

DTAI        szErrorMsgID_DTAI                    ON

GENLNG        idCacheCursor_GENLNG    I/ON

EV01        cReturnCursor_EV01                    IN

JOBS        mnJobNumber_JOBS                    IY

^

Parameter NameData ItemData TypeReq/OptI/O/Both
mnSampleCounter_SNBRSNBRMATH_NUMERICREQNONE

A number assigned to a group of tests within the same sample.

mnSampleNumber_SNBRSNBRMATH_NUMERICOPTNONE

A number assigned to a group of tests within the same sample.

nNumberOfKeys_INT01INT01integerOPTNONE

Number of Days in Future to Query for Responses Due. 

cProcessMode_EV01EV01charOPTNONE

An option that specifies the type of processing for an event.

cCacheCodeError_EV01EV01charOPTNONE

An option that specifies the type of processing for an event.

cSuppressErrorMsgs_EV01EV01charOPTNONE

An option that specifies the type of processing for an event.

szErrorMsgID_DTAIDTAIcharOPTNONE

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

idCacheCursor_GENLNGGENLNGIDOPTNONE

General purpose ID variable.

cReturnCursor_EV01EV01charOPTNONE

An option that specifies the type of processing for an event.

mnJobNumber_JOBSJOBSMATH_NUMERICREQNONE

The job number (work station ID) which executed the particular job.

Related Functions

None

Related Tables

None