A Appendix

The following appendixes sections include authorized special characters, character limitations, and static constants.

List of Authorized Special Characters in DIVArchive

The following table lists the special characters that can be used in DIVArchive and in which fields they are valid.

Table A-1 Special Authorized Characters in DIVArchive

Character Name Category Source Media Path File Comments Options

~

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

'

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

!

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

@

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

#

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

$

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

%

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

^

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

&

Yes

Yes

Yes

Yes

Yes

Yes

Yes

No

*

No

No

Yes

Yes

No

Yes

Yes

Yes

(

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

)

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

_

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

-

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

+

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

=

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

|

Yes

Yes

Yes

Yes

No

Yes

Yes

Yes

\

Yes

Yes

Yes

Yes

No

Yes

Yes

Yes

{

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

[

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

}

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

]

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

:

Yes

Yes

Yes

Yes

No

Yes

Yes

Yes

;

Yes

Yes

Yes

Yes

YesFoot 1 

Yes

Yes

Yes

"

Yes

Yes

Yes

Yes

No

Yes

Yes

No

'

Yes

Yes

No

No

YesFootref 1

Yes

Yes

Yes

<

Yes

Yes

Yes

Yes

No

Yes

Yes

No

,

Yes

Yes

Yes

Yes

YesFootref 1

Yes

Yes

Yes

>

Yes

Yes

Yes

Yes

No

Yes

Yes

Yes

.

Yes

Yes

Yes

Yes

No

Yes

Yes

Yes

?

Yes

Yes

Yes

Yes

No

Yes

Yes

Yes

/

Yes

Yes

Yes

Yes

No

Yes

Yes

Yes

Space

Yes

Yes

Yes

Yes

No

Yes

Yes

Yes

Footnote 1 In a Windows environment, the file and folder name restrictions depend on the file system restrictions. File and folder names cannot solely consist of one or more spaces, and cannot contain a double-quote.

Maximum Allowed Number of Characters

The maximum allowable number of characters are as follows:

Name

192 maximum characters

Category

96 maximum characters

Source

96 maximum characters

Media

96 maximum characters

Path and File Name

1536 maximum characters per folder or per file

Comments

4000 maximum characters

Options

768 maximum characters

API Static Constant Values

The following table identifies the values for each of the API static constants.

Table A-2 API Static Constants

Static Constant Name Description Value

DIVA_OK

The request was correctly submitted and accepted by the DIVArchive Manager.

1000

DIVA_ERR_UNKNOWN

An unknown status was received from the DIVArchive Manager.

1001

DIVA_ERR_INTERNAL

An internal error was detected by the DIVArchive Manager or the DIVArchive API.

1002

DIVA_ERR_NO_ARCHIVE_SYSTEM

Problem when establishing a connection with the specified DIVArchive system.

1003

DIVA_ERR_BROKEN_CONNECTION

The connection with the DIVArchive Manager was broken.

1004

DIVA_ERR_DISCONNECTING

Problem when disconnecting. The connection is still considered to be open.

1005

DIVA_ERR_ALREADY_CONNECTED

A connection is already open.

1006

DIVA_ERR_WRONG_VERSION

Release level of the API and the Manager are not compatible.

1007

DIVA_ERR_INVALID_PARAMETER

A parameter value was not understood by the DIVArchive Manager.

1008

DIVA_ERR_OBJECT_DOESNT_EXIST

The specified object does not exist in the DIVArchive database.

1009

DIVA_ERR_SEVERAL_OBJECTS

More than one object with the specified name exists in the DIVArchive database.

1010

DIVA_ERR_NO_SUCH_REQUEST

The requestNumber identifies no request.

1011

DIVA_ERR_NOT_CANCELABLE

The request is at the point where it cannot be canceled.

1012

DIVA_ERR_SYSTEM_IDLE

The DIVArchive System is no longer able to accept connections and queries.

1013

DIVA_ERR_WRONG_LIST_SIZE

The list size is zero or larger than the maximum allowable value.

1014

DIVA_ERR_LIST_NOT_INITIALIZED

The specified list was not properly initialized. Initialization call was not executed.

1015

DIVA_ERR_OBJECT_ALREADY_EXISTS

An object with this name and category already exists in the DIVArchive system.

1016

DIVA_ERR_GROUP_DOESNT_EXIST

The specified group does not exist.

1017

DIVA_ERR_SOURCE_OR_DESTINATION_DOESNT_EXIST

The specified source or destination does not exist.

1018

DIVA_WARN_NO_MORE_OBJECTS

The end of the list was reached during the call.

1019

DIVA_ERR_NOT_CONNECTED

No open connection.

1020

DIVA_ERR_GROUP_ALREADY_EXISTS

The specified group already exists.

1021

DIVA_ERR_GROUP_IN_USE

The group contains at least one object instance.

1022

DIVA_ERR_OBJECT_OFFLINE

There is no inserted instance in the library and no Actor could provide a disk instance.

1023

DIVA_ERR_TIMEOUT

The timeout limit was reached before communication with the DIVArchive Manager could be performed. The timeout duration is set by the DIVA_API_TIMEOUT variable and equals one hundred-eighty (180) seconds by default.

1024

DIVA_ERR_LAST_INSTANCE

DIVA_deleteObject() must be used to delete the last instance of an object.

1025

DIVA_ERR_PATH_DESTINATION

The specified destination path is invalid.

1026

DIVA_ERR_INSTANCE_DOESNT_EXIST

Instance specified for restoring this object does not exist.

1027

DIVA_ERR_INSTANCE_OFFLINE

Instance specified for restoring this object is ejected, or the Actor owning the specified disk instance is unavailable.

1028

DIVA_ERR_INSTANCE_MUST_BE_ON_TAPE

The specified instance is not a tape instance.

1029

DIVA_ERR_NO_INSTANCE_TAPE_EXIST

No tape instance exists for this object.

1030

DIVA_ERR_OBJECT_IN_USE

The object is currently in use (being Archived, Restored, Deleted, and so on).

1031

DIVA_ERR_CANNOT_ACCEPT_MORE_REQUESTS

The count of simultaneous requests reached the maximum allowed value. This variable is set in the manager.conf configuration file. The default is 300.

1032

DIVA_ERR_TAPE_DOESNT_EXIST

There is no tape associated with the given barcode.

1033

DIVA_ERR_INVALID_INSTANCE_TYPE

Cannot partially restore this instance.

1034

DIVA_ERR_OBJECT_PARTIALLY_DELETED

The specified object has instances that are partially deleted.

1036

DIVA_ERR_COMPONENT_NOT_FOUND

The specified component (file) is not found.

1038

DIVA_ERR_OBJECT_IS_LOCKED

Attempted to restore an object that has been locked. A locked object cannot be Restored or Copied to New.

1039

DIVA_ALL_REQUESTS

Specify all requests. Used by DIVA_cancelRequest.

-2

DIVA_ALL_INSTANCE

Specify all instances. Used by DIVA_release.

-1

DIVA_ANY_INSTANCE

Allow Manager to choose the instance.

-1

DIVA_DEFAULT_REQUEST_PRIORITY

The default request priority. This is used if no specific priority is selected when the request is configured.

-1

DIVA_REQUEST_PRIORITY_MIN

The default minimum request priority.

Default = 0

DIVA_REQUEST_PRIORITY_LOW

The default low request priority.

Default = 25

DIVA_REQUEST_PRIORITY_NORMAL

The default normal request priority.

Default = 50

DIVA_REQUEST_PRIORITY_HIGH

The default high request priority.

Default = 75

DIVA_REQUEST_PRIORITY_MAX

The default maximum request priority.

Default = 100

DIVA_MEDIA_FORMAT_UNKNOWN

The specified tape format is unknown.

-1

DIVA_MEDIA_FORMAT_LEGACY

The specified media format for the group or array is Legacy.

0

DIVA_MEDIA_FORMAT_AXF

The specified media format for the group or array is AXF 0.9.

1

DIVA_MEDIA_FORMAT_AXF_10

The specified media format for the group or array is AXF 1.0.

2

DIVA_OFFSET_BYTE_BEGIN

__int64 - The beginning byte of the file.

0

DIVA_OFFSET_BYTE_END

__int64 - The ending byte of the file.

-1

DIVA_OFFSET_INVALID

__int64 - The specified timecode offset is invalid.

-2

DIVA_OFFSET_TC_BEGIN

string - The file's beginning timecode.

00:00:00:00

DIVA_OFFSET_TC_END

string - The file's ending timecode.

99:99:99:99