JP1 Version 12 JP1/Base Function Reference


This manual explains in detail the functions provided by JP1/Base and the procedures used to extend the functions of JP1/Base during development of systems linked to JP1/Integrated Management. This manual is intended for all operating systems. When there is a difference in the functions available for the supported operating systems, a distinction to that effect is made in the manual.

Organization of this preface

■ Intended readers

This manual is intended for users who use JP1/IM and JP1/Base to develop systems that work with JP1/IM.

This manual assumes that the readers understand the functionality of JP1/IM and JP1/Base.

■ Organization of this manual

This manual consists of the following parts:

PART 1: Overview

Part 1 provides a brief overview of customizing and extending the JP1/Base functions.

PART 2: Operation

Part 2 explains how to customize the JP1/Base functions.

PART 3: Reference

Part 3 describes the JP1/Base functions in reference format.

■ JP1/Base manual organization

The JP1/Base documentation is divided into three manuals. Read the manual appropriate to your purpose, referring to the content of each manual shown in the following table.



JP1/Base User's Guide

  • Overview and functionality of JP1/Base

  • Setup of each function

  • Commands, definition files, JP1 events

  • Troubleshooting

  • Processes, port numbers, operation logs

JP1/Base Messages


JP1/Base Function Reference

  • Procedures for issuing and acquiring JP1 events with JP1 programs and user applications

  • Functions

■ Conventions: "Administrator permissions" as used in this manual

In this manual, Administrator permissions refers to Administrator permissions for the local PC. The local user, domain user, or user of the Active Directory environment can perform tasks requiring Administrator permissions if granted Administrator permissions for the local PC.

■ Conventions: Fonts and symbols

The following table explains the text formatting conventions used in this manual:

Text formatting



Bold characters indicate text in a window, other than the window title. Such text includes menus, menu options, buttons, radio box options, or explanatory labels. For example:

  • From the File menu, choose Open.

  • Click the Cancel button.

  • In the Enter name entry box, type your name.


Italic characters indicate a placeholder for some actual text to be provided by the user or system. For example:

  • Write the command as follows:

    copy source-file target-file

  • The following message appears:

    A file was not found. (file = file-name)

Italic characters are also used for emphasis. For example:

  • Do not delete the configuration file.


Monospace characters indicate text that the user enters without change, or text (such as messages) output by the system. For example:

  • At the prompt, enter dir.

  • Use the send command to send mail.

  • The following message is displayed:

    The password is incorrect.

The following table explains the symbols used in this manual:




In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR. For example:

A|B|C means A, or B, or C.

{ }

In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected. For example:

{A|B|C} means only one of A, or B, or C.

[ ]

In syntax explanations, square brackets indicate that the enclosed item or items are optional. For example:

[A] means that you can specify A or nothing.

[B|C] means that you can specify B, or C, or nothing.


In coding, an ellipsis (...) indicates that one or more lines of coding have been omitted.

In syntax explanations, an ellipsis indicates that the immediately preceding item can be repeated as many times as necessary. For example:

A, B, B, ... means that, after you specify A, B, you can specify B as many times as necessary.


Parentheses indicate the range of items to which the vertical bar (|) or ellipsis (...) is applicable.


This symbol is used to explicitly indicate a space. For example, AAA[Figure]BBB means that you must place a space between AAA and BBB.


When a syntax character shown above is used as an ordinary character, a backslash is prefixed to the character. For example, \| means | as an ordinary character, not as a syntax character.

■ Conventions: Version numbers

The version numbers of Hitachi program products are usually written as two sets of two digits each, separated by a hyphen. For example:

The version number might be shown on the spine of a manual as Ver. 2.00, but the same version number would be written in the program as 02-00.

■ JP1/Base installation folder for Windows

This manual refers to the JP1/Base installation folder in Windows as follows:

Product name

Reference to installation folder

Installation folder#



In an x86 environment:

system-drive:\Program Files\HITACHI\JP1Base

In an x64 environment:

system-drive:\Program Files (x86)\HITACHI\JP1Base


Denotes the installation folder used when the product is installed with initial settings. For Windows Vista or later, the manual uses the expression system-drive:\ProgramData. The actual value is determined by the OS environment variable when the program is installed. The installation destination might differ depending on the environment.


This manual uses the following convention to represent the full path of the JevApi.h header file needed to compile a source file:


For the default installation folder, this path would actually be system-drive:\Program Files\HITACHI\JP1Base\include\JevApi.h.

■ Other reference information

For other reference information, see Reference Material for this Manual in the JP1/Base User's Guide.