Hitachi

JP1 Version 12 JP1/IT Desktop Management 2 - Asset Console Creating an Access Definition File Guide


List of embedded functions

This section explains the embedded functions that can be defined in assignment statements.

The following table lists, in order of purpose, the embedded functions that can be used in access definition files.

Table 5‒1: List of embedded functions

Embedded function

Description

Purpose

Name of embedded function

Array operations

$GETARRAY

Reads data from an array.

$CLEARARRAY

Initializes an array.

$SETARRAY

Sets data into an array.

$SETARRAYBYKEY

Sets keyed data into an array.

$GETARRAYBYKEY

Reads keyed data from an array.

$GETKEYFROMARRAY

Reads the corresponding key from an array.

$UPDARRAY

Updates array data.

$UPDARRAYBYKEY

Updates keyed array data.

Block processing operations

$BREAK

Interrupts processing in a process block.

$GETSTATUS

Acquires the status of a process block.

$SETSTATUS

Sets the status of a process block.

Session information operations

$GETSESSION

Reads session information.

$GETTEMPNAME

Specifies the name of the work file for downloading that is created for a session.

$SETSESSION

Sets session information.

File operations

$FILEARRAY

Outputs information stored in an array to a CSV file.

$FILECLOSE

Ends editing of a file.

$FILECOPY

Copies a file (always overwrites any existing file).

$FILEDEL

Deletes a file.

$FILEOPEN

Begins editing of a file.

$FILEPUT

Outputs data to a file.

$FILEPUTLN

When data is being output to a file, adds a CRLF at the end.

$FINDFILE

Finds files.

Directory information operations

$LDAPACS

Performs confirmation of connections to directory service, searching, entry acquisition, attribute acquisition, and other directory service operations.

$GETROLE

Stores user roles in an array.

Subroutine

$GOSUB

Executes a subroutine.

Arithmetic operations

$ADD

Acquires the result of an add operation.

$CALCDATE

Calculates the date and time.

$DIV

Acquires the result of a division operation.

$MOD

Acquires the remainder of a division operation.

$MUL

Acquires the result of a multiplication operation.

$SUB

Acquires the result of a subtraction operation.

Information extraction

$SUBSTR

Extracts a substring.

$TOKEN

Extracts a token.

Information acquisition

$DATACOUNT

Acquires the result lines of the previous search.

$DATETIME

Acquires the current date and time.

Numbering

$NUMBER

Acquires sequential numbers from a database.

Acquisition of server environmental settings

$ENVIRONMENT

Acquires the environmental setting information of a server.

$GETREGVALUE

Acquires registry information for the server environment.

Process end

$EXIT

Ends processing of an access definition file.

$SETOPTION

Sets end options to handle errors.

Message output

$ECHO

Outputs a message to standard output.

$FORMATMSG

Formats a message text.

$LOGMSG

Outputs a message to a log file.

Conversion

$LOWER

Converts an alphabetic character string to lowercase.

$UPPER

Converts an alphabetic character string to uppercase.

Windows initialization file operations

$GETPROFILEDATA

Reads the keys and values of a Windows initialization file.

NULL value evaluation

$ISNULL

Determines whether or not a value is NULL.

Character string operations

$LENGTH

Acquires the length of a character string.

$MATCH

Evaluates a character string.

$STRCMP

Compares character strings.

DLL operations#

$DLLLOAD

Loads a DLL.

$DLLEXEC2

Executes a user function installed on a user-provided DLL.

$DLLFREE

Frees a DLL.

$DLLMSG

Acquires DLL messages.

#

In embedded functions that perform DLL operations, always use DLLs that have been created as 32-bit applications. Even if the OS you are using is Server 2008 R2, you must not use a DLL created as a 64-bit application.