CheckLocationMaster

Check Location Master

Major Business Rule

Object Name: B4000360

Parent DLL: COPBASE

Location: Client/Server

Language: C

Functional Description

Purpose
This business function verifies that the Location Master (F4100) record exists and returns a pointer 
to the Location Master Record.  You can retrieve a record from F4100 using one of six different 
indexes. 


Setup Notes and Prerequisites

• If a pointer to the record is returned, this pointer must be cleared in the application using the 

BSFN FreePtrtoDataStructure.


• The user passes to the business function the number of the index they want to use and the number of 

key fields within that index that will be used.


List of Indexes:


1. MCU, LOCN


2. MCU, WSQP, LOCN


3. MCU, WSQQ, LOCN


4. MCU, WSQR, LOCN


5. MCU, CGRP


6. MCU, PZON


• The returned error message will display automatically on the message line and the appropriate field 

(if any) will be highlighted. This can be suppressed by turning on the "Suppress Error Message" flag. 


• Turn on the "Return Pointer" flag to have the business function return a pointer to the record. 


• Set the "Call Type" flag to a "1" to have the business function verify that the record exists. Set 

it to "2" to have the business function verify that the record does not exist (ie. it returns an error 

if a record is found).

Initialize the DS F4100Pointer to NULL.


Fetch the Location Master Record corresponding to the index and keys entered by the user.  





If DS Call Type is equal to '1', return error messages.


Assign DS Error Message ID = '3138' (Invalid Location).


If DS Suppress Error Message is not equal to '1', SetGBRError where error message is '3138' ( 

Invalid Location ) and the first field in the index is highlighted.





If Fetch is successful, return pointer and messages.


If DS Call Type is equal to '2', return error messages.


 Assign DS Error Message ID = '2463'.


 If DS Suppress Error Message is not equal to '1', SetGBRError where error message is '2463' 

and the first field in the index is highlighted.


If DS Call Type is not equal to '2', return the Location Master information.





If  DS Call Type is not equal to '2' and DS Return Pointer is equal to '1', return pointer to the 

Location Master Record.


Allocate memory for the Location Master Record.


 If Memory Allocation is successful, Assign DS F4100 Pointer = Address of Location 

Master Record.


 If Memory Allocation is not successful, return error messages.


 Assign DS Error Message ID = '4365' (No Memory).


If DS Suppress Error Message is not equal to '1', SetGBRError where error message is 


'4365' and first field in index is highlighted.





Returns:


If Call Type is equal to '1' and the fetch fails, return Error Message ID '3138' (Invalid Location).


If Call Type is equal to '2' and the fetch is successful, return Error Message ID '2463'.


If Return Pointer is equal to '1', the fetch is successful, and the memory allocation is successful, 

return the pointer to the data structure.