OBJIO Storage Media

Macros
#define	OBJIO_SM_online_msg   "OBJIO_SM_online"
#define	OBJIO_SM_retrieve_msg   "OBJIO_SM_retrieve"
#define	OBJIO_SM_store_msg   "OBJIO_SM_store"

Functions
OBJIO_API int	OBJIO_SM_ask_description (tag_t media_tag, char description[OBJIO_SM_description_size_c+1])
OBJIO_API int	OBJIO_SM_ask_description2 (tag_t media_tag, char **description)
OBJIO_API int	OBJIO_SM_ask_if_online (tag_t media_tag, logical *online)
OBJIO_API int	OBJIO_SM_ask_logical_device (tag_t media_tag, char logical_device[OBJIO_SM_description_size_c+1])
OBJIO_API int	OBJIO_SM_ask_logical_device2 (tag_t media_tag, char **logical_device)
OBJIO_API int	OBJIO_SM_ask_media_name (tag_t media_tag, char media_name[OBJIO_SM_name_size_c+1])
OBJIO_API int	OBJIO_SM_ask_media_name2 (tag_t media_tag, char **media_name)
OBJIO_API int	OBJIO_SM_ask_media_type (tag_t media_tag, char media_type[OBJIO_SM_name_size_c+1])
OBJIO_API int	OBJIO_SM_ask_media_type2 (tag_t media_tag, char **media_type)
OBJIO_API int	OBJIO_SM_create_media (char media_name[OBJIO_SM_name_size_c+1], char logical_device[OBJIO_SM_description_size_c+1], char media_type[OBJIO_SM_name_size_c+1], tag_t *media_tag)
OBJIO_API int	OBJIO_SM_create_media2 (char *media_name, char *logical_device, char *media_type, tag_t *media_tag)
OBJIO_API int	OBJIO_SM_exists (tag_t media_tag, char filename[OBJIO_SM_name_size_c+1], int *doesnt_exist_flag)
OBJIO_API int	OBJIO_SM_exists2 (tag_t media_tag, char *filename, int *doesnt_exist_flag)
OBJIO_API int	OBJIO_SM_find_media (char media_name[OBJIO_SM_name_size_c+1], tag_t *media_tag)
OBJIO_API int	OBJIO_SM_find_media2 (char *media_name, tag_t *media_tag)
OBJIO_API int	OBJIO_SM_media_extent (int *media_count, tag_t **media_tags)
OBJIO_API int	OBJIO_SM_retrieve (tag_t media_tag, char filename[OBJIO_SM_name_size_c+1], char destination_dir[OBJIO_SM_name_size_c+1])
OBJIO_API int	OBJIO_SM_retrieve2 (tag_t media_tag, char *filename, char *destination_dir)
OBJIO_API int	OBJIO_SM_retrieve_file (tag_t media_tag, tag_t file_tag)
OBJIO_API int	OBJIO_SM_set_description (tag_t media_tag, char description[OBJIO_SM_description_size_c+1])
OBJIO_API int	OBJIO_SM_set_description2 (tag_t media_tag, char *description)
OBJIO_API int	OBJIO_SM_set_logical_device (tag_t media_tag, char logical_device[OBJIO_SM_description_size_c+1])
OBJIO_API int	OBJIO_SM_set_logical_device2 (tag_t media_tag, char *logical_device)
OBJIO_API int	OBJIO_SM_set_media_name (tag_t media_tag, char media_name[OBJIO_SM_name_size_c+1])
OBJIO_API int	OBJIO_SM_set_media_name2 (tag_t media_tag, char *media_name)
OBJIO_API int	OBJIO_SM_set_media_type (tag_t media_tag, char media_type[OBJIO_SM_name_size_c+1])
OBJIO_API int	OBJIO_SM_set_media_type2 (tag_t media_tag, char *media_type)
OBJIO_API int	OBJIO_SM_store (tag_t media_tag, char filename[OBJIO_SM_name_size_c+1], char source_dir[OBJIO_SM_name_size_c+1])
OBJIO_API int	OBJIO_SM_store2 (tag_t media_tag, char *filename, char *source_dir)
OBJIO_API int	OBJIO_SM_store_files (tag_t media_tag, int count, tag_t *tags_list)

Constants
The following are manifest constants for storage size in bytes of various small strings that can be returned by this module.
#define	OBJIO_SM_class_name_c   "StorageMedia"
#define	OBJIO_SM_Disk_Device   "Disk"
#define	OBJIO_SM_Tape_Device   "Tape"
#define	OBJIO_SM_name_size_c   32
#define	OBJIO_SM_description_size_c   240

Detailed Description

Macro Definition Documentation

#define OBJIO_SM_class_name_c   "StorageMedia"

Definition at line 26 of file objio_sm.h.

#define OBJIO_SM_description_size_c   240

Definition at line 30 of file objio_sm.h.

#define OBJIO_SM_Disk_Device   "Disk"

Definition at line 27 of file objio_sm.h.

#define OBJIO_SM_name_size_c   32

Definition at line 29 of file objio_sm.h.

#define OBJIO_SM_online_msg   "OBJIO_SM_online"

Definition at line 33 of file objio_sm.h.

#define OBJIO_SM_retrieve_msg   "OBJIO_SM_retrieve"

Definition at line 34 of file objio_sm.h.

#define OBJIO_SM_store_msg   "OBJIO_SM_store"

Definition at line 35 of file objio_sm.h.

#define OBJIO_SM_Tape_Device   "Tape"

Definition at line 28 of file objio_sm.h.

Function Documentation

OBJIO_API int OBJIO_SM_ask_description	(	tag_t	media_tag,
		char	description[OBJIO_SM_description_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use OBJIO_SM_ask_description2

Returns the attributes of the storage media object.

Parameters

media_tag	(I)
description	(O)

OBJIO_API int OBJIO_SM_ask_description2	(	tag_t	media_tag,
		char **	description
	)

Returns the attributes of the storage media object.

Parameters

media_tag	(I)
description	(OF)

OBJIO_API int OBJIO_SM_ask_if_online	(	tag_t	media_tag,
		logical *	online
	)

Returns a logical value that is true if the storage media is online, and false if it is not.

Parameters

media_tag	(I)
online	(O)

OBJIO_API int OBJIO_SM_ask_logical_device	(	tag_t	media_tag,
		char	logical_device[OBJIO_SM_description_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use OBJIO_SM_ask_logical_device2

Returns the attributes of the storage media object.

Parameters

media_tag	(I)
logical_device	(O)

OBJIO_API int OBJIO_SM_ask_logical_device2	(	tag_t	media_tag,
		char **	logical_device
	)

Returns the attributes of the storage media object.

Parameters

media_tag	(I)
logical_device	(OF)

OBJIO_API int OBJIO_SM_ask_media_name	(	tag_t	media_tag,
		char	media_name[OBJIO_SM_name_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use OBJIO_SM_ask_media_name2

Returns the attributes of the storage media object.

Parameters

media_tag	(I)
media_name	(O)

OBJIO_API int OBJIO_SM_ask_media_name2	(	tag_t	media_tag,
		char **	media_name
	)

Returns the attributes of the storage media object.

Parameters

media_tag	(I)
media_name	(OF)

OBJIO_API int OBJIO_SM_ask_media_type	(	tag_t	media_tag,
		char	media_type[OBJIO_SM_name_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use OBJIO_SM_ask_media_type2

Returns the attributes of the storage media object.

Parameters

media_tag	(I)
media_type	(O)

OBJIO_API int OBJIO_SM_ask_media_type2	(	tag_t	media_tag,
		char **	media_type
	)

Returns the attributes of the storage media object.

Parameters

media_tag	(I)
media_type	(OF)

OBJIO_API int OBJIO_SM_create_media	(	char	media_name[OBJIO_SM_name_size_c+1],
		char	logical_device[OBJIO_SM_description_size_c+1],
		char	media_type[OBJIO_SM_name_size_c+1],
		tag_t *	media_tag
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use OBJIO_SM_create_media2

Creates a storage media object. It is not saved to the database until an explicit call to AOM_save occurs.

Restrictions:

This function is only valid when you are logged in as the system administrator.

Parameters

media_name	(I)
logical_device	(I)
media_type	(I)
media_tag	(O)

OBJIO_API int OBJIO_SM_create_media2	(	char *	media_name,
		char *	logical_device,
		char *	media_type,
		tag_t *	media_tag
	)

Creates a storage media object. It is not saved to the database until an explicit call to AOM_save occurs.

Restrictions:

This function is only valid when you are logged in as the system administrator.

Parameters

media_name	(I)
logical_device	(I)
media_type	(I)
media_tag	(O)

OBJIO_API int OBJIO_SM_exists	(	tag_t	media_tag,
		char	filename[OBJIO_SM_name_size_c+1],
		int *	doesnt_exist_flag
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use OBJIO_SM_exists2

This routine returns 0 if the file exists, non-zero if it doesn't

Parameters

media_tag	(I)
filename	(I)
doesnt_exist_flag	(O)

OBJIO_API int OBJIO_SM_exists2	(	tag_t	media_tag,
		char *	filename,
		int *	doesnt_exist_flag
	)

This routine returns 0 if the file exists, non-zero if it doesn't

Parameters

media_tag	(I)
filename	(I)
doesnt_exist_flag	(O)

OBJIO_API int OBJIO_SM_find_media	(	char	media_name[OBJIO_SM_name_size_c+1],
		tag_t *	media_tag
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use OBJIO_SM_find_media2

Finds a storage media object with the specified device name. If no storage media exists with the specified device name, then a zero returns on the stack and a NULLTAG returns for the media_tag.

Parameters

media_name	(I)
media_tag	(O)

OBJIO_API int OBJIO_SM_find_media2	(	char *	media_name,
		tag_t *	media_tag
	)

Finds a storage media object with the specified device name. If no storage media exists with the specified device name, then a zero returns on the stack and a NULLTAG returns for the media_tag.

Parameters

media_name	(I)
media_tag	(O)

OBJIO_API int OBJIO_SM_media_extent	(	int *	media_count,
		tag_t **	media_tags
	)

Allocates an array of tags and stores in the array all media in the database. The client is responsible for deallocating the array of media_tags. Use MEM_free to free the memory pointed to by media_tags.

Parameters

media_count	(O) Stores the size of the array
media_tags	(OF) media_count Points to the array of tags

OBJIO_API int OBJIO_SM_retrieve	(	tag_t	media_tag,
		char	filename[OBJIO_SM_name_size_c+1],
		char	destination_dir[OBJIO_SM_name_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use OBJIO_SM_retrieve2

Parameters

media_tag	(I)
filename	(I)
destination_dir	(I)

OBJIO_API int OBJIO_SM_retrieve2	(	tag_t	media_tag,
		char *	filename,
		char *	destination_dir
	)

Parameters

media_tag	(I)
filename	(I)
destination_dir	(I)

OBJIO_API int OBJIO_SM_retrieve_file	(	tag_t	media_tag,
		tag_t	file_tag
	)

Retrieves a file, specified by a filename, from a storage media, specified by a media_tag, into a specified destination directory.

Parameters

media_tag	(I)
file_tag	(I)

OBJIO_API int OBJIO_SM_set_description	(	tag_t	media_tag,
		char	description[OBJIO_SM_description_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use OBJIO_SM_set_description2

Sets the attributes of the storage media object.

Restrictions:

This function is only valid when you are logged in as the system administrator.

Parameters

media_tag	(I)
description	(I)

OBJIO_API int OBJIO_SM_set_description2	(	tag_t	media_tag,
		char *	description
	)

Sets the attributes of the storage media object.

Restrictions:

This function is only valid when you are logged in as the system administrator.

Parameters

media_tag	(I)
description	(I)

OBJIO_API int OBJIO_SM_set_logical_device	(	tag_t	media_tag,
		char	logical_device[OBJIO_SM_description_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use OBJIO_SM_set_logical_device2

Sets the attributes of the storage media object.

Restrictions:

This function is only valid when you are logged in as the system administrator.

Parameters

media_tag	(I)
logical_device	(I)

OBJIO_API int OBJIO_SM_set_logical_device2	(	tag_t	media_tag,
		char *	logical_device
	)

Sets the attributes of the storage media object.

Restrictions:

This function is only valid when you are logged in as the system administrator.

Parameters

media_tag	(I)
logical_device	(I)

OBJIO_API int OBJIO_SM_set_media_name	(	tag_t	media_tag,
		char	media_name[OBJIO_SM_name_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use OBJIO_SM_set_media_name2

Sets the attributes of the storage media object.

Restrictions:

This function is only valid when you are logged in as the system administrator.

Parameters

media_tag	(I)
media_name	(I)

OBJIO_API int OBJIO_SM_set_media_name2	(	tag_t	media_tag,
		char *	media_name
	)

Sets the attributes of the storage media object.

Restrictions:

This function is only valid when you are logged in as the system administrator.

Parameters

media_tag	(I)
media_name	(I)

OBJIO_API int OBJIO_SM_set_media_type	(	tag_t	media_tag,
		char	media_type[OBJIO_SM_name_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use OBJIO_SM_set_media_type2

Sets the attributes of the storage media object.

Restrictions:

This function is only valid when you are logged in as the system administrator.

Parameters

media_tag	(I)
media_type	(I)

OBJIO_API int OBJIO_SM_set_media_type2	(	tag_t	media_tag,
		char *	media_type
	)

Sets the attributes of the storage media object.

Restrictions:

This function is only valid when you are logged in as the system administrator.

Parameters

media_tag	(I)
media_type	(I)

OBJIO_API int OBJIO_SM_store	(	tag_t	media_tag,
		char	filename[OBJIO_SM_name_size_c+1],
		char	source_dir[OBJIO_SM_name_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use OBJIO_SM_store2

Stores the specified file, identified by a filename and source directory, to a storage media specified by a media_tag.

Parameters

media_tag	(I)
filename	(I)
source_dir	(I)

OBJIO_API int OBJIO_SM_store2	(	tag_t	media_tag,
		char *	filename,
		char *	source_dir
	)

Stores the specified file, identified by a filename and source directory, to a storage media specified by a media_tag.

Parameters

media_tag	(I)
filename	(I)
source_dir	(I)

OBJIO_API int OBJIO_SM_store_files	(	tag_t	media_tag,
		int	count,
		tag_t *	tags_list
	)

Parameters

media_tag	(I)
count	(I)
tags_list	(I)