CONTENTS Title Page Copyright Page Preface 1 Introduction 1.1 Documentation Format for File Cabinet Server Routines 1.1.1 Routine Name 1.1.2 Syntax 1.1.3 C Format 1.1.4 Return Value 1.1.5 Arguments 1.1.6 Condition Values 1.1.7 Rules 1.1.8 Content Rules 1.1.9 MS-DOS and Windows Rules 1.1.10 ULTRIX Rules 1.1.11 OpenVMS Rules 1.2 Synchronous and Asynchronous Calls 2 Common Data Structures 3 Main Arguments 3.1 all_source 3.1.1 unique_id_p 3.1.2 collection 3.1.3 coll_len 3.1.4 first 3.1.5 last 3.1.6 scope 3.1.7 qualification 3.1.7.1 Qualification Tags 3.1.7.2 Using Wildcard Tags 3.1.7.3 Qualification optimizations 3.1.8 qual_len 3.2 attributes 3.2.1 TLV-Encoding in the ALL-IN-1 File Cabinet 3.2.1.1 Message Envelope Identifiers 3.2.1.2 Application Message Content Identifiers 3.2.1.3 Service Message and Receipt Notification Reports 3.2.2 TLV-Encoding Attributes 3.2.3 Access Control Lists 3.2.3.1 Modifying The ACL of a Drawer 3.2.3.2 Modifying the ACL of a Document 3.2.4 Listing Attributes 3.2.5 Deleting Attributes 3.2.6 Adding or Modifying Attributes 3.2.7 Vectored Attributes 3.2.7.1 Adding Index Attribute Values 3.2.7.2 Adding a New First Value 3.2.7.3 Modifying Vectored Attribute Values 3.2.7.4 Deleting Vectored Attribute Values 3.2.7.5 Match and Modify Vectored Attribute Values 3.2.7.6 Using Vectored Attributes and the Index Tags 3.2.7.7 Vectored Attributes Within Qualification Expressions 3.3 content_control_block 3.3.1 content_procedure 3.3.2 content_buffer 3.3.3 content_buffer_size 3.3.4 content_buffer_length 3.3.5 content_procedure_params 3.3.6 content_flags 3.4 content_describe_block 3.4.1 attributes_p 3.4.1.1 data_type 3.4.1.2 org 3.4.1.3 rfm 3.4.1.4 rat 3.4.1.5 bls 3.4.1.6 mrs 3.4.1.7 alq 3.4.1.8 bks 3.4.1.9 fsz 3.4.1.10 mrn 3.4.1.11 deq 3.4.1.12 fop 3.4.1.13 bsz 3.4.1.14 dev 3.4.1.15 sdc 3.4.1.16 lrl 3.4.1.17 hbk 3.4.1.18 ebk 3.4.1.19 ffb 3.4.1.20 sbn 3.4.2 rffu 3.5 cm_parameters 3.6 collection 3.7 drawer_src 3.7.1 function 3.7.2 dr_qual_p 3.7.3 next_drawer_p 3.7.4 start_drawer_p 3.7.5 request_count 3.7.6 returned_count 3.8 fc_name 3.9 queue_status_block 3.10 reporting 3.10.1 flags 3.10.2 errortn 3.10.3 Logrtn 3.11 session 3.12 session_characteristics 3.13 status_block 3.13.1 completrtn_p 3.13.2 appl_context 3.13.3 request_id 3.13.4 status1 3.13.5 status2 3.13.6 success_cnt 3.13.7 failure_cnt 3.13.8 usrefn 3.14 unique_id 4 General Rules for Routines 5 Main Routines OafcAddDrawertoFileCab OafcAddtoCollection OafcAttach OafcCancel OafcCloseCabinet OafcConvertUID OafcCopy OafcCreate OafcCrossFile OafcDelete OafcDeletefromCollection OafcDetach OafcFree OafcGetData OafcGetNewMail OafcList OafcModifyAttributes OafcOpenCabinet OafcPutData OafcReadFolderNames OafcReadNewMail OafcRefile OafcRemoveDrawerfromFileCab OafcReserve OafcSendMail OafcSubmitScript OafcWait 6 OpenVMS System Management Routines and Facilities 6.1 The File Cabinet Server Trace Facility 6.1.1 Format of Trace Log File 6.1.1.1 task_id 6.1.1.2 session_id 6.1.1.3 fc_name 6.1.1.4 trace_event 6.1.1.5 timestamp 6.1.1.6 funct 6.1.1.7 status 6.1.1.8 string1 6.1.1.9 string2 6.1.1.10 reserved 6.1.2 Uses of the Tracing Facility 6.1.3 The OAFC$PRINT_TRACE_LOG Utility 6.2 The File Cabinet Server Logging Facility OafcCreatePartition OafcDeletePartition OafcSetFileCabinet OafcSetPartition OafcSetServer OafcShowFileCabinet OafcShowPartition OafcShowServer 7 Error Messages 7.1 Messages By Message Name 7.2 Messages By Message Number EXAMPLES 2-1 Data Structure Definitions FIGURES 3-1 TLV Encoding of Qualification Tags 5-1 Attachments TABLES 1-1 Call Syntax 1-2 Access Entries 3-1 Argument Fields 3-2 Scope Values 3-3 Qualification Tags 3-4 Qualification Attributes 3-5 Attribute Tags for Drawers 3-6 Attribute Tags for Folders 3-7 Attribute Tags for Documents 3-8 Extended Attributes Tags for Documents 3-9 TLV Item Values in ALL-IN-1 IOS 3-10 Message Envelope Identifier Tags 3-11 Message Content Identifier Tags 3-12 Service Message and Receipt Notification Tags 3-13 Content Control Block Fields 3-14 Content Describe Block Fields 3-15 Content Management Parameters Tags 3-16 Valid Function Field Values 3-17 File Cabinet Name Formats 3-18 Queue Status Block Fields 3-19 Reporting Fields 3-20 Flags Bit Mask Values 3-21 Session Characteristics Values 3-22 Status Block Fields 5-1 OafcAttach Content Management Tags 5-2 UID Conversion TLVs 5-3 OafcCopy Content Management Tags 5-4 Required Attributes for OafcCreate 5-5 Attributes for Creating Mail Messages 5-6 OafcCreate Content Management Tags 5-7 OafcDelete Content Management Tags 5-8 OafcDetach Content Management Tags 5-9 OafcGetData Content Management Tags 5-10 Traversal_order Values 5-11 Valid Languages for Running a Server 5-12 OafcOpenCabinet Content Management Tags 5-13 OafcOpenCabinet Attributes Tags 5-14 OafcT_OpenConnect Tag Values 5-15 OafcPutData Content Management Tags 5-16 Folder Tag Definitions 5-17 OafcReadNewMail Attribute Tags 5-18 OafcReadNewMail Content Management Tags 5-19 OafcRefile Content Management Tags 5-20 OafcReserve Operation Attribute Tags 5-21 OafcReserve Content Management Tags 5-22 OafcSendMail Function Tags 5-23 OafcSendMail Content Management Tags 5-24 OafcSubmitScript function_code Values 5-25 Job Status Masks 5-26 Queue Status Masks 6-1 String1 Field Values for the Trace Record 6-2 String2 Field Values for the Trace Record 6-3 OafcCreatePartition Attribute Tags 6-4 Extended Definitions for OafcCreatePartition Attribute Tags 6-5 OafcSetFileCabinet Attribute Tags 6-6 Extended Definitions for OafcSetFileCabinet Attribute Tags 6-7 OafcSetPartition Attribute Tags 6-8 Extended Definitions for OafcSetPartition Attribute Tags 6-9 OafcSetServer Attribute Tags 6-10 OafcShowFileCabinet Attribute Tags 6-11 OafcShowPartition Attribute Tags 6-12 Extended Definitions for OafcShowPartition Attribute Tags 6-13 OafcShowServer Attribute Tags 7-1 File Cabinet Server Message Numbers