Reading and Changing Attributes (HLCF)

Use ft_frattributes() and ft_frattributes_aet to read file attributes, and ft_fcattributes() and ft_fcattributes_aet() to change file attributes by making only one call.

ft_frattributes()

#include %</opt/ftam/include/map.h>
#include %</opt/ftam/include/mapftam.h>
Return_code 
ft_frattributes (dirname, filename, ae_label, 
                return_event_name, input_dcb, inout_dcb)
Ae_dir_name                            dirname;
Ft_filename                            filename;
Ae_label                               *ae_label;
Local_event_name                       return_event_name;
struct Ft_frattributes_in_dcb          *input_dcb;
struct Ft_frattributes_out_dcb         **inout_dcb;

Use ft_frattributes() to read file attributes. Examples of using ft_frattributes() are as follows.

You might want to use ft_frattributes() to determine the creation dates when a deleting files older than a specific date. Another example of using ft_frattributes() is to know how to set destination file attributes when copying files with low level calls.

If the responder supports the conc_access field of struct Ft_access_control_element, and the file has access control elements, and an identity field matches the init_id, the input_dcb->concurrency_control must be a subset of the values stored in the conc_access. HP-UX responders do not support the conc_access field of struct Ft_access_control_element.
The input_dcb->attribute_names field defaults to indicate all attributes in the attribute_groups negotiated.
You must supply matching passwords in input_dcb->file_passwords for FT_FA_READ and FT_FA_READ_ATTRIBUTE file actions if the following conditions exist.
- If the file contains an identity (in Ft_access_control_element) that matches the init_id AND
- If passwords exist for these file actions
HP-UX responders set storage_account, future_filesize, legal_qualifications, and private_use so that the indication no value available (0) returns when you invoke ft_frattributes().

Ft_frattributes_in_dcb

struct  Ft_frattributes_in_dcb {
        Ft_initiator_identity           init_id;
        Ft_single_file_pw               filestore_pw;
        struct  Ft_file_passwords       file_passwords;
        Ft_attribute_names              attribute_names;
        Ft_account                      account;
        struct Ft_concurrency_control   *concurrency_control;
};

Ft_frattributes_out_dcb

struct  Ft_frattributes_out_dcb       {
        Uint32                     size;
        struct Api_rc              result; 
        enum    Ft_action_result   action_result;
        struct  Ft_attributes      attributes;
        struct  Ft_charging        *charging;
        struct  Ft_diagnostic      *diagnostic;
};

ft_frattributes() Parameters

ft_frattributes() Parameter	Type	Description
dirname	Optional Input	Directory distinguished name of the filestore; NULL implies the local filestore
filename	Mandatory Input	Path name of the file that has the attributes you are reading; must be in the syntax of the real filestore
ae_label	Mandatory Input	Unique identifier for ftam_init you want to service the request; if pointing to a NULL location, the interface uses a currently activated ftam_init or activates and deactivates a ftam_init
	Output	Unique identifier for ftam_init that serviced the request
return_event_name	Mandatory Input	If the call is asynchronous, uniquely identifies the function call; if the call is synchronous, the value is 0 (zero)
input_dcb->init_id	Optional Input	Login account
input_dcb-> filestore_pw	Optional Input	Login password for init_id
input_dcb-> file_passwords	Optional Input	Structure containing the passwords for FT_FA_READ and FT_FA_READ_ATTRIBUTE. Set file_passwords only if the file has an identity (in Ft_access_control_element) that matches init_id and if passwords exist for these two actions
input_dcb-> attribute_names	Optional Input	Mask that indicates which file attributes to read
input_dcb->account	Optional Input	Identifies who is responsible for accumulated file storage charges; HP-UX responders accept, but ignore, this value
input_dcb-> concurrency_control	Optional input (Used only with non—HP-UX responders.)	Sets the concurrency control for filename; compared to conc_access in struct Ft_access_control_element if an identity field matches the init_id
inout_dcb->size	Mandatory input if using inout_dcb	Size (in Octets) of the inout_dcb structure and data
inout_dcb->result	Output	Pointer to the struct Api_rc containing the outcome of the operation: result_code (MAP 3.0 error) and vendor_code (HP-UX—specific error)
inout_dcb-> action_result	Output	Specifies the overall success or failure of the request
inout_dcb->attributes	Output	Contains values of the attributes of the file you read
inout_dcb->charging	Output	HP-UX responders do not use charging, though it may contain information from other responders
inout_dcb-> diagnostic	Output	Provides ISO-specific error information

ft_fcattributes()

#include %</opt/ftam/include/map.h>
#include %</opt/ftam/include/mapftam.h>
Return_code 
ft_fcattributes (dirname, filename, ae_label, 
                 return_event_name, input_dcb, inout_dcb)
Ae_dir_name                            dirname;
Ft_filename                            filename;
Ae_label                               *ae_label;
Local_event_name                       return_event_name;
struct Ft_fcattributes_in_dcb          *input_dcb;
struct Ft_fcattributes_out_dcb         **inout_dcb;

Use ft_fcattributes() to change file attributes. For example, you can change an attribute such as access_control to place file access restrictions on a specific user.

The attribute_groups negotiated dictate the attributes you can change.

Attributes You Can Change

Attributes You Cannot Change

access_control

file_availability

filename

future_filesize*

legal_qualification*

private_use*

storage_account*

contents_type

date_time_of_attribute_mod

date_time_of_creation

date_time_of_modification

date_time_of_read filesize

identity_of_attribute_mod

identity_of_creator

identity_of_modifier

identity_of_reader

permitted_actions

* HP-UX responders accept, but ignore, these values.

If the responder supports the conc_access field of struct Ft_access_control_element, and the file has access control elements, and an identity field matches the init_id, the input_dcb->concurrency_control must be a subset of the values stored in the conc_access. HP-UX responders do not support the conc_access field of struct Ft_access_control_element.
You must supply matching passwords in input_dcb->file_passwords for FT_FA_READ and FT_FA_CHANGE_ATTRIBUTE file actions if the following conditions exist.
- If the file contains an identity (in Ft_access_control_element) that matches the init_id AND
- If passwords exist for these file actions

Ft_fcattributes_in_dcb

struct  Ft_fcattributes_in_dcb {
        Ft_initiator_identity           init_id;
        Ft_single_file_pw               filestore_pw;
        struct  Ft_file_passwords       file_passwords;
        Ft_attribute_names              attribute_names;
        struct  Ft_attributes           attributes;
        Ft_account                      account;
        struct Ft_concurrency_control   *concurrency_control;
};

Ft_fcattributes_out_dcb

struct  Ft_fcattributes_out_dcb {
        Uint32                     size;
        struct Api_rc              result;
        enum    Ft_action_result   action_result;
        struct  Ft_attributes      attributes;
        struct  Ft_charging        *charging;
        struct  Ft_diagnostic      *diagnostic;
};

ft_fcattributes() Parameters

ft_fcattributes() Parameter	Type	Description
dirname	Optional Input	Directory distinguished name of the filestore; NULL implies the local filestore
filename	Mandatory Input	Path name of the file that has the attributes you are changing; must be in the syntax of the real filestore
ae_label	Mandatory Input	Unique identifier for ftam_init you want to service the request; if pointing to a NULL location, the interface uses a currently activated ftam_init or activates and deactivates a ftam_init
	Output	Unique identifies the ftam_init that serviced the request
return_event_name	Mandatory Input	If the call is asynchronous, uniquely identifies the function call; if the call is synchronous, the value is 0 (zero)
input_dcb-> attribute_names	Mandatory Input	Mask that indicates which file attributes to change
input_dcb-> attributes.values	Mandatory Input	Contains values you want to change for the attributes given in attribute_names
input_dcb->init_id	Optional Input	Login account
input_dcb-> filestore_pw	Optional Input	Login password for init_id
input_dcb->account	Optional input	Identifies who is responsible for accumulated file storage charges; HP-UX responders accept, but ignore, this value
input_dcb-> concurrency_control	Optional input Used only when using access control	Sets the concurrency control for filename; compared to conc_access in struct Ft_access_control_element if an identity field matches the init_id
inout_dcb->size	Mandatory input if using inout_dcb	Size (in Octets) of the inout_dcb structure and data
inout_dcb->result	Output	Pointer to the struct Api_rc containing the outcome of the operation: result_code (MAP 3.0 error) and vendor_code (HP-UX—specific error)
inout_dcb-> action_result	Output	Specifies the overall success or failure of the request
inout_dcb-> attributes	Output	Contains values of the attributes that changed; access_passwords do not return
inout_dcb-> charging	Output	HP-UX responders do not use charging, though it may contain information from other responders
inout_dcb-> diagnostic	Output	Provides ISO-specific error information
input_dcb-> file_passwords	Optional Input	Structure containing the passwords for FT_FA_READ and FT_FA_CHANGE_ATTRIBUTE. Set file_passwords only if the file has an identity (in Ft_access_control_element) that matches init_id and if passwords exist for these two actions

ft_frattributes_aet()

#include %</opt/ftam/include/map.h>
#include %</opt/ftam/include/mapftam.h>
Return_code 
ft_frattributes_aet (ascii_ddn, filename, ae_label, 
                return_event_name, input_dcb, inout_dcb)
char                                   *ascii_ddn;
Ft_filename                            filename;
Ae_label                               *ae_label;
Local_event_name                       return_event_name;
struct Ft_frattributes_in_dcb          *input_dcb;
struct Ft_frattributes_out_dcb         **inout_dcb;

Use ft_frattributes_aet() to read file attributes. Examples of using ft_frattributes_aet() are as follows.

You might want to use ft_frattributes_aet() to determine the creation dates when a deleting files older than a specific date. Another example of using ft_frattributes_aet() is to know how to set destination file attributes when copying files with low level calls.

Both ft_frattributes_aet() and ft_frattributes() are used for reading file attributes. However, ft_frattributes_aet() sends both the Called AE Title and calling AE title to the remote system while ft_frattributes() sends only the calling AE title. Also, in ft_frattributes_aet(), the DDN is passed directly as an ASCII string without any conversion while in ft_frattributes(), the DDN has to be converted and passed as an Ae_dir_name.
If the responder supports the conc_access field of struct Ft_access_control_element, and the file has access control elements, and an identity field matches the init_id, the input_dcb->concurrency_control must be a subset of the values stored in the conc_access. HP-UX responders do not support the conc_access field of struct Ft_access_control_element.
The input_dcb->attribute_names field defaults to indicate all attributes in the attribute_groups negotiated.
You must supply matching passwords in input_dcb->file_passwords for FT_FA_READ and FT_FA_READ_ATTRIBUTE file actions if the following conditions exist.
- If the file contains an identity (in Ft_access_control_element) that matches the init_id AND
- If passwords exist for these file actions
HP-UX responders set storage_account, future_filesize, legal_qualifications, and private_use so that the indication no value available (0) returns when you invoke ft_frattributes_aet().

Ft_frattributes_in_dcb

struct  Ft_frattributes_in_dcb {
        Ft_initiator_identity           init_id;
        Ft_single_file_pw               filestore_pw;
        struct  Ft_file_passwords       file_passwords;
        Ft_attribute_names              attribute_names;
        Ft_account                      account;
        struct Ft_concurrency_control   *concurrency_control;
};

Ft_frattributes_out_dcb

struct  Ft_frattributes_out_dcb       {
        Uint32                     size;
        struct Api_rc              result; 
        enum    Ft_action_result   action_result;
        struct  Ft_attributes      attributes;
        struct  Ft_charging        *charging;
        struct  Ft_diagnostic      *diagnostic;
};

ft_frattributes_aet() Parameters

ft_frattributes_aet() Parameter	Type	Description
ascii_ddn	Optional Input	Directory distinguished name of the filestore in ASCII; NULL implies the local filestore
filename	Mandatory Input	Path name of the file that has the attributes you are reading; must be in the syntax of the real filestore
ae_label	Mandatory Input	Unique identifier for ftam_init you want to service the request; if pointing to a NULL location, the interface uses a currently activated ftam_init or activates and deactivates a ftam_init
	Output	Unique identifier for ftam_init that serviced the request
return_event_name	Mandatory Input	If the call is asynchronous, uniquely identifies the function call; if the call is synchronous, the value is 0 (zero)
input_dcb->init_id	Optional Input	Login account
input_dcb-> filestore_pw	Optional Input	Login password for init_id
input_dcb-> file_passwords	Optional Input	Structure containing the passwords for FT_FA_READ and FT_FA_READ_ATTRIBUTE. Set file_passwords only if the file has an identity (in Ft_access_control_element) that matches init_id and if passwords exist for these two actions
input_dcb-> attribute_names	Optional Input	Mask that indicates which file attributes to read
input_dcb->account	Optional Input	Identifies who is responsible for accumulated file storage charges; HP-UX responders accept, but ignore, this value
input_dcb-> concurrency_control	Optional input (Used only with non—HP-UX responders.)	Sets the concurrency control for filename; compared to conc_access in struct Ft_access_control_element if an identity field matches the init_id
inout_dcb->size	Mandatory input if using inout_dcb	Size (in Octets) of the inout_dcb structure and data
inout_dcb->result	Output	Pointer to the struct Api_rc containing the outcome of the operation: result_code (MAP 3.0 error) and vendor_code (HP-UX—specific error)
inout_dcb-> action_result	Output	Specifies the overall success or failure of the request
inout_dcb->attributes	Output	Contains values of the attributes of the file you read
inout_dcb->charging	Output	HP-UX responders do not use charging, though it may contain information from other responders
inout_dcb-> diagnostic	Output	Provides ISO-specific error information

ft_fcattributes_aet()

#include %</opt/ftam/include/map.h>
#include %</opt/ftam/include/mapftam.h>
Return_code 
ft_fcattributes_aet (ascii_ddn, filename, ae_label, 
                 return_event_name, input_dcb, inout_dcb)
char                                   *ascii_ddn;
Ft_filename                            filename;
Ae_label                               *ae_label;
Local_event_name                       return_event_name;
struct Ft_fcattributes_in_dcb          *input_dcb;
struct Ft_fcattributes_out_dcb         **inout_dcb;

Use ft_fcattributes_aet() to change file attributes. For example, you can change an attribute such as access_control to place file access restrictions on a specific user.

Both ft_fcattributes_aet() and ft_fcattributes() are used for changing file attributes. However, ft_fcattributes_aet() sends both the Called AE Title and calling AE title to the remote system while ft_fcattributes() sends only the calling AE title. Also, in ft_fcattributes_aet(), the DDN is passed directly as an ASCII string without any conversion while in ft_fcattributes(), the DDN has to be converted and passed as an Ae_dir_name.

The attribute_groups negotiated dictate the attributes you can change.

Attributes You Can Change

Attributes You Cannot Change

access_control

file_availability

filename

future_filesize*

legal_qualification*

private_use*

storage_account*

contents_type

date_time_of_attribute_mod

date_time_of_creation

date_time_of_modification

date_time_of_read

filesize

identity_of_attribute_mod

identity_of_creator

identity_of_modifier

identity_of_reader

permitted_actions

* HP-UX responders accept, but ignore, these values.

If the responder supports the conc_access field of struct Ft_access_control_element, and the file has access control elements, and an identity field matches the init_id, the input_dcb->concurrency_control must be a subset of the values stored in the conc_access. HP-UX responders do not support the conc_access field of struct Ft_access_control_element.
You must supply matching passwords in input_dcb->file_passwords for FT_FA_READ and FT_FA_CHANGE_ATTRIBUTE file actions if the following conditions exist.
- If the file contains an identity (in Ft_access_control_element) that matches the init_id AND
- If passwords exist for these file actions

Ft_fcattributes_in_dcb

struct  Ft_fcattributes_in_dcb {
        Ft_initiator_identity           init_id;
        Ft_single_file_pw               filestore_pw;
        struct  Ft_file_passwords       file_passwords;
        Ft_attribute_names              attribute_names;
        struct  Ft_attributes           attributes;
        Ft_account                      account;
        struct Ft_concurrency_control   *concurrency_control;
};

Ft_fcattributes_out_dcb

struct  Ft_fcattributes_out_dcb {
        Uint32                     size;
        struct Api_rc              result;
        enum    Ft_action_result   action_result;
        struct  Ft_attributes      attributes;
        struct  Ft_charging        *charging;
        struct  Ft_diagnostic      *diagnostic;
};

ft_fcattributes_aet() Parameters

ft_fcattributes_aet() Parameter	Type	Description
ascii_ddn	Optional Input	Directory distinguished name of the filestore in ASCII; NULL implies the local filestore
filename	Mandatory Input	Path name of the file that has the attributes you are changing; must be in the syntax of the real filestore
ae_label	Mandatory Input	Uniquely identifier for ftam_init you want to service the request; if pointing to a NULL location, the interface uses a currently activated ftam_init or activates and deactivates a ftam_init
	Output	Uniquely identifies the ftam_init that serviced the request
return_event_name	Mandatory Input	If the call is asynchronous, uniquely identifies the function call; if the call is synchronous, the value is 0 (zero)
input_dcb-> attribute_names	Mandatory Input	Mask that indicates which file attributes to change
input_dcb-> attributes.values	Mandatory Input	Contains values you want to change for the attributes given in attribute_names
input_dcb->init_id	Optional Input	Login account
input_dcb-> filestore_pw	Optional Input	Login password for init_id
input_dcb->account	Optional input	Identifies who is responsible for accumulated file storage charges; HP-UX responders accept, but ignore, this value
input_dcb-> concurrency_control	Optional input (Used only when using access control)	Sets the concurrency control for filename; compared to conc_access in struct Ft_access_control_element if an identity field matches the init_id
inout_dcb->size	Mandatory input if using inout_dcb	Size (in Octets) of the inout_dcb structure and data
inout_dcb->result	Output	Pointer to the struct Api_rc containing the outcome of the operation: result_code (MAP 3.0 error) and vendor_code (HP-UX—specific error)
inout_dcb-> action_result	Output	Specifies the overall success or failure of the request
inout_dcb-> attributes	Output	Contains values of the attributes that changed; access_passwords do not return
inout_dcb-> charging	Output	HP-UX responders do not use charging, though it may contain information from other responders
inout_dcb-> diagnostic	Output	Provides ISO-specific error information
input_dcb-> file_passwords	Optional Input	Structure containing the passwords for FT_FA_READ and FT_FA_CHANGE_ATTRIBUTE. Set file_passwords only if the file has an identity (in Ft_access_control_element) that matches init_id and if passwords exist for these two actions

Reading and Changing Attributes (HLCF)

Technical documentation

» Table of Contents

» Glossary

» Index

ft_frattributes()

Ft_frattributes_in_dcb

Ft_frattributes_out_dcb

ft_frattributes() Parameters

ft_fcattributes()

Ft_fcattributes_in_dcb

Ft_fcattributes_out_dcb

ft_fcattributes() Parameters

ft_frattributes_aet()

Ft_frattributes_in_dcb

Ft_frattributes_out_dcb

ft_frattributes_aet() Parameters

ft_fcattributes_aet()

Ft_fcattributes_in_dcb

Ft_fcattributes_out_dcb

ft_fcattributes_aet() Parameters