arm_register_application (3) - Linux Manuals
arm_register_application: describe application
NAME
arm_register_application - describe applicationSYNOPSIS
#include <arm4.h>
arm_error_t
arm_register_application(
DESCRIPTION
arm_register_application() describes metadata about an application.The application uses arm_register_application() to inform the ARM library of metadata about the application. This metadata does not change from one application instance to another. It contains part of the function of the ARM 2.0 call arm_init(); arm_start_application() contains the other part.
ARM generates an ID that is passed in arm_register_transaction() and arm_start_application().
app_name is a pointer to a null-terminated string containing the name of the application. The maximum length of the name is 128 characters, including the termination character. It serves no purpose and is illegal to make this call if the pointer is null. A name should be chosen that is unique, so generic names that might be used by a different development team, such as "Payroll Application", should not be used. The name should not contain trailing blank characters or consist of only blank characters. If the application has a copyrighted product name, the copyrighted name would be a good choice.
buffer4 is a pointer to the user data buffer, if any. If the pointer is null (ARM_BUF4_NONE),
there is no buffer. The sub-buffer formats that might be used are
arm_subbuffer_app_identity_t and arm_subbuffer_encoding_t.
input_app_id is a pointer to an optional 128-bit ID (16 bytes) that is unique and that can be treated as
an alias for the other metadata. It can be any value except all zeros or all ones. If the
pointer is null (ARM_ID_NONE), no ID is provided.
output_app_id is a pointer to a 16-byte field. ARM will store a 16-byte value. There are no
requirements on what value it is set to, except that it must be possible to pass it on
other calls, such as arm_start_application(), without the application needing to do
any error checking.
The following errors are recognized by this implementation, but may not be portable to other implementations:
RETURN VALUE
On success, the function returns ARM_SUCCESS. A non-zero value indicates
an error.
ERRORS
If the return code is negative, an error occurred. If the return code is not negative, an error may
or may not have occurred - the determination of what is an error and whether an error code is
returned is at the discretion of the ARM implementation. The application can test the return code
if it wants to provide its own error logging.
CONFORMING TO
ARM Issue 4.0 C Language Bindings, Version 2
EXAMPLE
None.