GetEnvironmentData

Get Environment Data

Minor Business Rule

Object Name: B1701170

Parent DLL: CALLBSFN

Location: Client

Language: C

1.Functional Description
This function retrieves processing option data and operating system for the E-Help e-mail message.

1.1Purpose
This function uses the application name, and version to retrieve the processing option data string , also the operating system written to the E-Help
e-mail message.

1.2Setup Notes and Prerequisites


1.3Special Logic
This function uses the JDBGetTableColInformation  API to retrieve the processing options blob from the table F983051. When calling this function
you must send the form name and version name.
The processing option data will be returned in a string that separates each value by a '|'.
To get the operating system the GetVersionEx API is used.  The business function will return a 'W' is the operating system value is
VER_PLATFORM_WIN32_WINDOWS .  It will return an 'N' is the operating system is  VER_PLATFORM_WIN32_NT.
2.Technical Specifications

2.1Parameters:
Data Item Data Structure Description   I/ORequiredNotes
PID                  Program Id                      I     Y                Program name
VER                  Version consolidated       I     Y                Version name
EV01                  Operating System     O     N                Operating system flag  'W' - Win32_Windows
                                                                                                                                                                         "N' - Win32_NT
DL01                  Server Name                     O     N                Server Name - future
PODATA  Processing Option text     O     N                Processing option text string

2.4Related Tables
Table Table Description
F983051Processing Options

2.4Related Business Functions
Source NameFunction Name

2.4Processing
To retrieve the processing option data :
•  Fetch from F983051 without a return columns data structure

• Using JDB_GetTableColInfo API move the column information for the PO Data into a COLINFO structure

This contains no actual file data, but rather describes the column of data that was returned

  by the fetch

•  Copy the data into a BLOBVALUE structure using a memcpy.  This should describe for the blob data in
the column because,  of the variable size of blob data, the actual data is stored elsewhere.  You can
use this data to go find it.

•  Allocate enough space to hold the blob value using jdeAlloc API

•  Now copy the actual blobdata string into the space you just allocated  using a memcpy.

• Copy this allocated space to your string data structure parameter for Processing Option data using a
strncpy .

• Free the allocated space.

To determine operating system :
• Use GetVersionEx API to get the operating system value.
• Compare to VER_PLATFORM_WIN32_WINDOWS  and if equal return a 'W' in operating system flag.
• Compare to VER_PLATFORM_WIN32_NT and if equal return an 'N' in operating system flag.

Data Structure

D1701170 - Get Environment Data

Parameter Name Data Item Data Type Req/Opt I/O/Both

szProgramId PID char OPT NONE

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value.
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry
program.

szVersionconsolidated VER char OPT NONE

Identifies a specific set of data selection and sequencing settings for the application. Versions may be named using any combination of
alpha and numeric characters. Versions that begin with 'XJDE' or 'ZJDE' are set up by J.D. Edwards.

cOperatingSystem EV01 char OPT NONE

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

szServer DL01 char OPT NONE

A user defined name or remark.

szProcessingOptionText TXPP char OPT NONE

An all-purpose string that the system uses to temporarily display large amounts of text.

Related Functions

None

Related Tables

F983051 Versions List

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szProgramId	PID	char	OPT	NONE
The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry program.
szVersionconsolidated	VER	char	OPT	NONE
Identifies a specific set of data selection and sequencing settings for the application. Versions may be named using any combination of alpha and numeric characters. Versions that begin with 'XJDE' or 'ZJDE' are set up by J.D. Edwards.
cOperatingSystem	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
szServer	DL01	char	OPT	NONE
A user defined name or remark.
szProcessingOptionText	TXPP	char	OPT	NONE
An all-purpose string that the system uses to temporarily display large amounts of text.