EMC DiskXtender. API Reference Guide. Release 6.4 Microsoft Windows Version P/N REV A01

Transcription

1 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide P/N REV A01 EMC Corporation Corporate Headquarters: Hopkinton, MA

2 Copyright EMC Corporation. All rights reserved. Published March, 2009 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date regulatory document for your product line, go to the Technical Documentation and Advisories section on EMC Powerlink. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks used herein are the property of their respective owners. 2 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

3 Contents Preface Chapter 1 Chapter 2 Introduction DiskXtender SDK components DiskXtender client API DiskXtender event notification API System requirements Installing the DiskXtender SDK Packing list SDK installation folders SDK user files DxDmClient Constants Extended drive constants DX_FILTER_FLAG_ DX_FILTER_INDEXING_STATE_ DX_FILTER_SCAN_ACTION_ DX_FILTER_SCAN_FLAG_ S_FILTER_STATUS_ File constants AGE_FROM_ COPY_FILE_ DX_EXPIRATION_TYPE_ DX_FILE_STATE_ DX_RECYCLER_EXCLUDE_STATE DX_RETENTION_SET_FLAG_ DX_RETENTION_DISPOSITION_ FILE_ATTRIBUTE_ FILE_SHARE_ Media and hardware device constants DX_LIST_ S_DRIVE_TYPE_ S_FINALIZE_TYPE_ S_FS_TYPE_ S_FS_CLASS_ S_ITEM_FILTER_ S_LIB_SIDE_ S_MEDIA_ATTRIBUTE_ EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide 3

4 Contents S_MEDIA_CLASS_ S_MEDIA_SERVICE_STATUS_ S_MEDIA_SERVICE_TYPE_ S_MEDIA_STATUS_ S_MEDIA_TYPE_ TASK_STATUS_ TASK_TYPE_ Log and report constants AUDIT_LOG_FILTER_ DX_TRACE_ LOG_TYPE_ Message types RTF_ALIGN_ RTF_ATTR_ RTF_COLOR_ RTF_FONT_ RTF_FONTSIZE_ RTF_LINE_STYLE_ S_AUDIT_OBJECT_TYPE_ S_AUDIT_OBJECT_ACTION_ Miscellaneous constants ALERT_ DX_ACCESS_ DX_PREFETCH_TYPE_ DX_PRIORITY_ DX_RPC_EP_ GENERIC_ RPC_PROTOCOL_ S_ITEM_REORDER_ S_ITEM_TYPE_ S_RULE_RESULT_ SCHEDULE_TYPE_ SERVICE_ WEEK_DAY_ Chapter 3 DxDmClient Structures Extended drive and media folder structures DX_FILTER DX_FILTER_META_DATA DX_FILTER_INFO DX_FILTER_SCAN DX_FILTER_STATS DX_PROPERTY DX_MEDIA_FOLDER File structures DX_RECYCLER_FILE FILE_SPEC FILETIME WIN32_FIND_DATA Rule structures DX_MOVE_RULE DX_INDEX_RULE DX_PURGE_RULE DX_DELETE_RULE EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

5 Contents Media structures Media service structures Media group structures General media structures Media task structures Fetch structures DX_FETCH DX_PREFETCH DX_PREFETCH_FILE DX_PREFETCH_STATS Log and report structures AUDIT_LOG_CFG AUDIT_LOG_HEADER DX_FILE_REPORT_REC DX_FILE_REPORT_SUMMARY DX_REPORT_OPTIONS LOG_CFG REPORT_LAYOUT REPORT_STYLE TRACE_MSG Miscellaneous structures ALERT DX_EVENT_SCHEDULE DX_PART_MAP DX_SCHEDULE DX_SERVICE_CFG DX_SPECIAL_APPS SETUP_INFO Chapter 4 DxDmClient Function Prototypes Extended drive and media folder functions General extended drive functions Media folder functions Background scan functions Indexing functions Metadata export functions Recycler functions File and folder functions File functions Folder functions Rule functions Move rule functions Index rule functions Purge rule functions Delete rule functions General rule functions Media functions Media service functions Media group functions General media functions Media task functions Fetch functions Fetch request functions Prefetch functions EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide 5

6 Contents Log and report functions Media log functions Trace functions Error string functions Log viewer functions Report layout functions Report option functions Report style functions Registry log functions Event log functions Audit log functions File report functions Miscellaneous functions DiskXtender service functions Special application filtering functions Partition map functions Find functions Reordering functions Chapter 5 DxNotify DXN_EVENT structure Extended drive events DXN_FILTER_SCAN_BEGIN DXN_FILTER_SCAN_END DXN_FILTER_SET_OFFLINE DXN_FILTER_SET_ONLINE Media service event constants DXN_MEDIA_SERVICE_SET_OFFLINE DXN_MEDIA_SERVICE_SET_ONLINE Media event constants DXN_MEDIA_FAILURE DXN_MEDIA_SET_OFFLINE DXN_MEDIA_SET_ONLINE File migration event constants DXN_FILE_MOVE_QUERY DXN_FILE_MOVE_COMPLETE DXN_FILE_MOVE_FAILURE File purge event constants DXN_FILE_PURGE_QUERY DXN_FILE_PURGE_COMPLETE DXN_FILE_PURGE_FAILURE File fetch event constants DXN_FILE_FETCH_SUBMIT DXN_FILE_FETCH_COMPLETE DXN_FILE_FETCH_FAILURE Direct Read event constants DXN_DIRECT_READ_OPEN DXN_DIRECT_READ_CLOSE DXN_DIRECT_READ_FAILURE DxNotify handler event constants DXN_INITIALIZE DXN_SHUTDOWN Index 6 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

7 Preface As part of an effort to improve and enhance the performance and capabilities of its product lines, EMC periodically releases revisions of its hardware and software. Therefore, some functions described in this document may not be supported by all versions of the software or hardware currently in use. For the most up-to-date information on product features, refer to your product release notes. If a product does not function properly or does not function as described in this document, please contact your EMC representative. Audience Related documentation Conventions used in this document This document is part of the EMC DiskXtender for Windows documentation set, and is intended for use by programmers. Readers of this document are expected to be familiar with the following topics: DiskXtender for Windows product features SDK programming C language prototyping Related documents include: EMC DiskXtender Release 6.4 Microsoft Windows Version Installation Guide EMC DiskXtender Release 6.4 Microsoft Windows Version Administration Guide EMC DiskXtender Release 6.4 Microsoft Windows Version Release Notes EMC DiskXtender Release 6.4 Microsoft Windows Version Technical Product Overview EMC DiskXtender Release 6.4 Microsoft Windows Version Best Practices Guide EMC DiskXtender Search Module Release 1.1 Installation Guide EMC DiskXtender Search Module Release 1.2 Release Notes EMC uses the following conventions for special notices. Note: A note presents information that is important, but not hazard-related.! CAUTION A caution contains information essential to avoid data loss or damage to the system or equipment.! IMPORTANT An important notice contains information essential to operation of the software. EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide 7

8 Preface Typographical conventions EMC uses the following type style conventions in this document: Normal Used in running (nonprocedural) text for: Names of interface elements (such as names of windows, dialog boxes, buttons, fields, and menus) Names of resources, attributes, pools, Boolean expressions, buttons, DQL statements, keywords, clauses, environment variables, functions, utilities URLs, pathnames, filenames, directory names, computer names, filenames, links, groups, service keys, file systems, notifications Bold Used in running (nonprocedural) text for: Names of commands, daemons, options, programs, processes, services, applications, utilities, kernels, notifications, system call, man pages Used in procedures for: Names of interface elements (such as names of windows, dialog boxes, buttons, fields, and menus) What user specifically selects, clicks, presses, or types Italic Used in all text (including procedures) for: Full titles of publications referenced in text Emphasis (for example a new term) Variables Courier Used for: System output, such as an error message or script URLs, complete paths, filenames, prompts, and syntax when shown outside of running text Courier bold Used for: Specific user input (such as commands) Courier italic Used in procedures for: Variables on command line User input variables < > Angle brackets enclose parameter or variable values supplied by the user [ ] Square brackets enclose optional values Vertical bar indicates alternate selections - the bar means or { } Braces indicate content that you must specify (that is, x or y or z)... Ellipses indicate nonessential information omitted from the example Where to get help Your comments EMC support, product, and licensing information can be obtained as follows. Product information For documentation, release notes, software updates, or for information about EMC products, licensing, and service, go to the EMC Powerlink website (registration required) at: Technical support For technical support, go to EMC Customer Service on Powerlink. To open a service request through Powerlink, you must have a valid support agreement. Please contact your EMC sales representative for details about obtaining a valid support agreement or to answer any questions about your account. Your suggestions will help us continue to improve the accuracy, organization, and overall quality of the user publications. Please send your opinion of this document to: SSGdocumentation@emc.com 8 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

9 Invisible Body Tag 1 Introduction The EMC DiskXtender 6.4 software development kit (SDK) is designed to enable developers to implement custom solutions built on the foundation of the DiskXtender storage system. The following topics provide an introduction to the DiskXtender SDK: DiskXtender SDK components System requirements Installing the DiskXtender SDK Packing list Introduction 9

10 Introduction DiskXtender SDK components The EMC DiskXtender for Windows SDK provides two different methods of application integration: DiskXtender client API (DxDmClient) DiskXtender event notification API (DxNotify) DiskXtender client API The DxDmClient toolkit provides application developers with the ability to automate storage management processes. This toolkit provides access to and direct control of the DiskXtender service and extended drive configuration. Developers can use the API to perform the following functions: Media service management: Configure access to media services Set media services online and offline List all installed media services Get media service status Extended drive management: Create and delete extended drives Configure media folders Configure media groups Configure move, index, purge, and delete rules Define task schedules Define indexing and background scan schedules and settings Manage prefetch requests Get extended drive statistics File management: Create and delete folders on an extended drive Create and delete files on an extended drive Read, write, seek, and set attributes for files (standard I/O calls) Find files and folders on an extended drive (file enumeration) Media management: Add media to media groups for file migration Remove media from media groups Schedule media tasks (format, label, restore, and so on) Get media information and statistics Retrieve and clear media logs Order and reorder the media task queue Service management: Configure service settings, alerts, and trace settings Configure, retrieve and clear service logs (events, warnings, and errors) and audit logs 10 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

11 Introduction The DiskXtender for Windows product runs as a seamless extension to the operating system itself, with no programming required. However, the DxDmClient toolkit can be integrated into client applications to achieve additional control. By taking advantage of this toolkit, resource-intensive applications can be deployed quickly, easily, and at significantly lower cost. Storage resources can become part of the application itself and can be directly controlled by the application. DxDmClient uses Microsoft remote procedure calls (RPCs) to communicate with the DiskXtender service. Any language capable of calling standard 64-bit Microsoft Windows DLLs can utilize this interface. The toolkit includes royalty-free distribution. The following chapters provide details on DxDmClient: Chapter 2, DxDmClient Constants Chapter 3, DxDmClient Structures Chapter 4, DxDmClient Function Prototypes DiskXtender event notification API The DiskXtender for Windows event notification feature (DxNotify) enables application developers to hook into the DiskXtender system and receive code-level notification of select, significant events that occur in the DiskXtender system during runtime. Once a client application receives notification of an event, it can take action. For example, if an application receives notification that a file has been moved to media, it can write an entry for the moved file in its database. An application can also prevent an operation based on an event notification. For example, if the application receives notification that a file is about to be moved to media, it can prevent the move. To accomplish this event notification, DxNotify enables you to create a custom DLL that is demand-loaded by the DiskXtender service at runtime. This DLL receives real-time event notification messages when various system events take place. The DLL must meet the following requirements: The DLL must be recognizable to, loadable by, and usable by a Microsoft Visual C++ 64-bit executable. The DLL may be named anything reasonable, but must have either a.dll or.dxn file extension. The DLL must be copied to the Plug Ins subdirectory of the main product installation (for example, C:\Program Files\EMC\DiskXtender\Plug Ins). This location is where DiskXtender looks when attempting to demand-load DxNotify DLLs. DiskXtender SDK components 11

12 Introduction The DLL must contain the DxNotifyHandler and DxNotifyVersion functions: DxNotifyHandler is the event notification handler. This handler is called once for each system event that requires a notification message be sent. All string arguments, like filename, sent to the notification handler by DiskXtender are Unicode:! IMPORTANT The notification calling thread comes directly from the DiskXtender service. It is not a specially spawned worker thread that can be used to perform lengthy tasks. Separate threads should be spawned to perform such activities, and the notification calling thread should be allowed to return promptly to the service. Failure to heed this request could significantly hinder the performance of the DiskXtender system. CALLBACK NotifyHandler(DM_EVENT* pevent) { ulresult = 0; if (pevent->eventid == DXN_INITIALIZE) { // Do whatever } // Always return 0 unless answering a QUERY notfication! return ulresult; } DxNotifyVersion enables the system to query the DLL for a version to ensure that everything is compatible: CALLBACK NotifyVersion() { return DXN_PLUGIN_VERSION; } A working sample C program called DxNotifySpy is provided with the DiskXtender SDK. DxNotifySpy is available in C:\DiskXtender SDK\SAMPLES\VC, where C:\DiskXtender SDK is the SDK installation directory. Chapter 5, DxNotify, provides details on the DiskXtender event notification API. 12 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

13 Introduction System requirements The environment in which you use the DiskXtender SDK must meet the requirements listed in Table 1 on page 13. Table 1 DiskXtender SDK system requirements Requirement Details Operating system Windows XP Windows Server 2003 Windows Server 2008 DiskXtender release Programming languages Client application Security This toolkit is designed to work with DiskXtender 6.4. It is not compatible with earlier versions of DiskXtender. Microsoft Visual C++ 6.0, and Microsoft Visual Studio.NET. The DiskXtender SDK is designed to work with C and C++ programming languages. All documentation is written using C function prototyping. Sample programs were built and tested using Microsoft Visual Studio 6.0. Client applications using this API must be 64-bit applications. There is no support for 16-bit applications. Both Unicode and ANSI character sets are supported. Users logged into DiskXtender through the API must be a member of the appropriate DiskXtender group on the DiskXtender server: DxUsers for read-only functions (query, list, etc.) DxAdministrators for write functions (create, edit, delete, etc.) DxSecurityAdmins for audit log functionality Note: When logging into the DiskXtender server, the username and password of the user are encrypted before transmittal over RPC. System requirements 13

14 Introduction Installing the DiskXtender SDK To install the DiskXtender SDK: 1. Ensure that the computer on which you are installing the SDK meets the requirements listed in System requirements on page Double-click the Setup.exe file in the DxSDK directory to launch the setup wizard. 3. Click Next on the first page of the wizard. The Installation Options page appears, as shown in Figure 1 on page 14. Figure 1 DiskXtender SDK Setup Wizard Installation Options page 4. Select Install new product and click Next. The License Agreement page appears, as shown in Figure 2 on page 14. Figure 2 DiskXtender SDK Setup Wizard License Agreement page 5. Review the license agreement. 6. Select the Accept terms of agreement checkbox and click Next. Note: You must scroll through the entire license agreement to enable the checkbox. 14 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

15 Introduction The Registration page appears, as shown in Figure 3 on page 15. Figure 3 DiskXtender SDK Setup Wizard Registration page 7. Type a customer name and organization in the text boxes, and then click Next. The Install Location page appears, as shown in Figure 4 on page 15. Figure 4 DiskXtender SDK Setup Wizard Install Location page 8. Type the path to the directory in which you want to install the DiskXtender SDK, and then click Next. The Summary page appears. 9. Review the information in the summary, and click Finish. When the installation is complete, a confirmation message appears. 10. Click Exit. Installing the DiskXtender SDK 15

16 Introduction Packing list In addition to this document, the DiskXtender SDK includes the following files: Setup files (to install, update, and uninstall the toolkit) Header/include files for C/C++ Sample applications in C/C++ 64-bit import library and runtime DLL for ANSI and Unicode character sets License for unlimited runtime distribution SDK installation folders Table 2 Table 2 on page 16 lists the folders that are installed with the DiskXtender SDK. These folders are installed in the installation folder specified during setup. The default installation folder is C:\DiskXtender SDK. SDK installation folders Folder \BIN \BIN\Ansi \BIN\Unicode...\Documentation...\INCLUDE \SAMPLES Contents Files required by setup for uninstall ANSI redistribution binaries UNICODE redistribution binaries This document (the EMC DiskXtender API Reference Guide) C/C++ header (include) files C/C++ sample programs SDK user files Table 3 on page 16 lists the files that are used to create client applications. These files are installed in the installation folder specified during setup. The default installation folder is C:\DiskXtender SDK. Table 3 SDK user files (page 1 of 2) File Location CommonMsg.dll and CommonMsg.lib DxDmClient.dll and DxDmClient.lib \BIN\Ansi and \BIN\Unicode \BIN\Ansi and \BIN\Unicode These files contain message resources for all DiskXtender messages and is used by DxDmClient.dll for message translation. These files are the dynamic link library and import library for the RPC client API. There are two versions of this file provided with the toolkit one for ANSI character sets and one for Unicode character sets. The proper DLL/LIB file must be used with a project, depending on the character model of the client application. DxDefs.h \INCLUDE This file contains DiskXtender-specific structure definitions used with the RPC client API. DxDmClient.h \INCLUDE This file contains function prototypes of the API calls provided by the DiskXtender SDK. DxNotify4.h \INCLUDE This file contains definitions used in the DiskXtender event notification API. 16 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

17 Introduction Table 3 SDK user files (page 2 of 2) File Location ExtendedErrors.h \INCLUDE This file contains extended error definitions for error codes returned by the DiskXtender RPC client API. DiskXtender makes use of Win32 error codes whenever possible. However, these errors are limited and sometimes too generic. DiskXtender uses extended errors when there is no suitable Win32 error that would satisfy a certain error condition. GenericDefs.h \INCLUDE This file contains standard #include directives and preprocessor definitions used by C/C++ projects. This file should be included first for C projects using the RPC client API (before any other SDK header files). GenericTypes.h \INCLUDE This file contains generic structures and types definitions used with the RPC client API. StorageDefs.h \INCLUDE This file contains storage-specific structure and type definitions used with the RPC client API. Redistribution files The following files are required during runtime and can be freely distributed with any application: C:\DiskXtender SDK\BIN\Ansi\CommonMsg.dll C:\DiskXtender SDK\BIN\Ansi\DxDmClient.dll C:\DiskXtender SDK\BIN\Unicode\CommonMsg.dll C:\DiskXtender SDK\BIN\Unicode\DxDmClient.dll C:\DiskXtender SDK is the DiskXtender SDK installation directory specified during setup. Packing list 17

18 Introduction 18 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

19 Invisible Body Tag 2 DxDmClient Constants This chapter lists the DxDmClient constants: Extended drive constants File constants Media and hardware device constants Log and report constants Miscellaneous constants DxDmClient Constants 19

20 DxDmClient Constants Extended drive constants The constants in the following sections define values for a DiskXtender for Windows extended drive. DX_FILTER_FLAG_ Table 4 Table 4 on page 20 provides the definitions for the DX_FILTER_FLAG_ constant. DX_FILTER_FLAG_ constant definitions DX_FILTER_FLAG_FILTERING DX_FILTER_FLAG_ACCESS_DENIED DX_FILTER_FLAG_REMOVABLE DX_FILTER_FLAG_NTFS Meaning The drive is extended. The drive is locked. It cannot be accessed. The drive is removable and cannot be extended. The drive is NTFS and can be extended. DX_FILTER_INDEXING_STATE_ Table 5 on page 20 provides the definitions for the DX_FILTER_INDEXING_STATE_ constant. Table 5 DX_FILTER_INDEXING_STATE_ constant definitions DX_FILTER_INDEXING_STATE_NORMAL DX_FILTER_INDEXING_STATE_SYNC_INDEX DX_FILTER_INDEXING_STATE_SYNC_VOLUME DX_FILTER_INDEXING_STATE_SYNC_FULL Meaning The indexing process will index files on the Index Transaction Log (ITL). Not used. Not used. The indexing process will synchronize the files on the extended drive with the index files on the ISE server. DX_FILTER_SCAN_ACTION_ Table 6 on page 20 provides the definitions for the DX_FILTER_SCAN_ACTION_ constant. Table 6 DX_FILTER_SCAN_ACTION_ constant definitions (page 1 of 2) DX_FILTER_SCAN_ACTION_START_NEW Meaning The background scan will be started. If a scan is currently in progress, the scan will be aborted and then restarted. 20 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

21 DxDmClient Constants Table 6 DX_FILTER_SCAN_ACTION_ constant definitions (page 2 of 2) DX_FILTER_SCAN_ACTION_SET_TO_IDLE DX_FILTER_SCAN_ACTION_SAVE_CONFIG DX_FILTER_SCAN_ACTION_SAVE_CONFIG_AND_START_NEW Meaning The background scan that is in progress will be aborted. Values from the DX_FILTER_SCAN structure that can be persisted will be saved to the Windows registry on the DiskXtender server. DX_FILTER_SCAN on page 55 provides details on the structure. Saves values from the DX_FILTER_SCAN structure to the Windows registry on the DiskXtender server, and then starts or restarts a background scan. DX_FILTER_SCAN_FLAG_ Table 7 on page 21 provides the definitions for the DX_FILTER_SCAN_FLAG_ constant. Table 7 DX_FILTER_SCAN_FLAG_ constant definitions DX_FILTER_SCAN_FLAG_DELETE_ORPHANED_FILES DX_FILTER_SCAN_FLAG_STRIP_DIRECT_READ_ATTRIBUTES DX_FILTER_SCAN_FLAG_STRIP_INDEXED_ATTRIBUTES DX_FILTER_SCAN_FLAG_STRIP_NO_INDEX_ATTRIBUTES DX_FILTER_SCAN_FLAG_DELETE_EXISTING_MOVE_LIST DX_FILTER_SCAN_FLAG_DELETE_EXISTING_SYNC_LIST Meaning The background scan should delete any purged file on the extended drive that has migration information with a media identifier for a piece of media that cannot be found. If the file has been migrated to multiple pieces of media, then none of the pieces of media must be found before the file is deleted. The background scan should strip the Direct Read attribute from all files on which it is set. The background scan should strip the Indexed attribute from all files on which it is set. The background scan should strip the Do Not Index attribute from all files on which it is set. The background scan should delete the existing move lists and create new ones. The background scan should delete the existing sync-fetch lists and create new ones. Extended drive constants 21

22 DxDmClient Constants S_FILTER_STATUS_ Table 8 Table 8 on page 22 provides the definitions for the S_FILTER_STATUS_ constant. S_FILTER_STATUS_ constant definitions S_FILTER_STATUS_OFFLINE S_FILTER_STATUS_ONLINE S_FILTER_STATUS_SETTING_OFFLINE S_FILTER_STATUS_SETTING_ONLINE S_FILTER_STATUS_PAUSED S_FILTER_STATUS_BACKUP_INPROGRESS S_FILTER_STATUS_BACKUP_RESTORE_INPROGRESS Meaning The extended drive is offline. The extended drive is online. The extended drive is being set offline. The extended drive is being set online. Not used. An extended drive metadata export is in progress. An extended drive metadata import is in progress. 22 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

23 DxDmClient Constants File constants The constants in the following sections define values for files on a DiskXtender for Windows extended drive. AGE_FROM_ Table 9 Table 9 on page 23 provides the definitions for the AGE_FROM_ constant. AGE_FROM_ constant definitions AGE_FROM_CREATE AGE_FROM_LAST_WRITE AGE_FROM_LAST_ACCESS AGE_FROM_DATE_DELETED Meaning File age is calculated from the create time. File age is calculated from the last write time. File age is calculated from the last access time. File age is calculated from the date the file was deleted. This file age is for the DiskXtender Recycler. COPY_FILE_ Table 10 on page 23 provides the definitions for the COPY_FILE_ constant. Table 10 COPY_FILE_ constant definitions COPY_FILE_FAIL_IF_EXISTS COPY_FILE_RESTARTABLE Meaning Copy fails if the file already exists. Copy can be restarted at a later time. DX_EXPIRATION_TYPE_ Table 11 Table 11 on page 23 provides the definitions for the DX_EXPIRATION_TYPE_ constant. DX_EXPIRATION_TYPE_ constant definitions DX_EXPIRATION_TYPE_NONE DX_EXPIRATION_TYPE_CREATE DX_EXPIRATION_TYPE_LAST_ACCESS DX_EXPIRATION_TYPE_LAST_WRITE Meaning No expiration policy has been defined. Expiration policy is based on the date and time the file is created. Expiration policy is based on the date and time the file was last accessed. Expiration policy is based on the date and time the file was last written on. File constants 23

24 DxDmClient Constants DX_FILE_STATE_ Table 12 Table 12 on page 24 provides the definitions for the DX_FILE_STATE_ constant. DX_FILE_STATE_ constant definitions DX_FILE_STATE_UNUSED DX_FILE_STATE_FETCHED DX_FILE_STATE_PURGED DX_FILE_STATE_DIRECTORY Meaning The file is not yet moved or purged. The file has been moved to storage media. It is present on the extended drive. The file data has been moved to media and purged from the extended drive. The file is a directory. DX_RECYCLER_EXCLUDE_STATE Table 13 on page 24 provides the definitions for the DX_RECYCLER_EXCLUDE_STATE_ constant. Table 13 DX_RECYCLER_EXCLUDE_STATE_ constant definitions DX_RECYCLER_EXCLUDE_STATE_NONE DX_RECYCLER_EXCLUDE_STATE_UNUSED DX_RECYCLER_EXCLUDE_STATE_FETCHED DX_RECYCLER_EXCLUDE_STATE_PURGED Meaning Include all files that are deleted from the extended drive in the DiskXtender Recycler. Exclude files that are not managed by DiskXtender. Exclude files that have been fetched from storage media. Exclude files that have been moved to media and purged from the extended drive. DX_RETENTION_SET_FLAG_ Table 14 on page 24 provides the definitions for the DX_RETENTION_SET_FLAG_ constant. Table 14 DX_RETENTION_SET_FLAG_ constant definitions DX_RETENTION_SET_FLAG_SET DX_RETENTION_SET_FLAG_UPDATE Meaning Set retention for the file. Edit the retention setting for the file. 24 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

25 DxDmClient Constants DX_RETENTION_DISPOSITION_ Table 15 on page 25 provides the definitions for the DX_RETENTION_DISPOSITION_ constant. Table 15 DX_RETENTION_DISPOSITION_ constant definitions DX_RETENTION_DISPOSITION_SUCCESS DX_RETENTION_DISPOSITION_ALREADY_SET DX_RETENTION_DISPOSITION_NOT_SET DX_RETENTION_DISPOSITION_ERROR Meaning Retention was successfully set or edited for the file. The DX_RETENTION_SET_FLAG_SET flag from the DX_RETENTION_SET_FLAG_ constant was passed in, but retention was already set for the file. The DX_RETENTION_SET_FLAG_UPDATE flag from the DX_RETENTION_SET_FLAG_ constant was passed in, but the file had no existing retention setting to edit. An error occurred while attempting to set retention for the file. FILE_ATTRIBUTE_ Table 16 Table 16 on page 25 provides the definitions for the FILE_ATTRIBUTE_ constant. FILE_ATTRIBUTE_ constant definitions FILE_ATTRIBUTE_NORMAL FILE_ATTRIBUTE_ARCHIVE FILE_ATTRIBUTE_DIRECTORY FILE_ATTRIBUTE_OFFLINE FILE_ATTRIBUTE_HIDDEN FILE_ATTRIBUTE_READONLY FILE_ATTRIBUTE_SYSTEM FILE_ATTRIBUTE_TEMPORARY Meaning The file is normal. This attribute is valid only if used alone. The file is an archive file. Applications use this attribute to mark files for backup or removal. The file is a directory. The file data is not available. It has been moved offline. The file is hidden. It is not to be included in an ordinary directory listing. The file is read only. Applications can read the file but cannot write to it or delete it. The file is part of or is used exclusively by the operating system. The file is being used for temporary storage. FILE_SHARE_ Table 17 on page 25 provides the definitions for the FILE_SHARE_ constant. Table 17 FILE_SHARE_ constant definitions FILE_SHARE_DELETE FILE_SHARE_READ FILE_SHARE_WRITE Meaning Open operations will succeed if delete access is requested. Open operations will succeed if read access is requested. Open operations will succeed if write access is requested. File constants 25

26 DxDmClient Constants Media and hardware device constants The constants in the following sections define values for media and hardware devices. DX_LIST_ Table 18 on page 26 provides the definitions for the DX_LIST_ constant. Table 18 DX_LIST_ constant definitions DX_LIST_ALL DX_LIST_BY_MEDIA_FOLDER DX_LIST_BY_MOVE_GROUP DX_LIST_AVAILABLE DX_LIST_USED DX_LIST_BY_MEDIA_SERVICE Meaning List all media. List all media in a specified media folder. List all media in a specified media group. List all media available to add to a media group. List all media in media groups. List only media that belong to the specified service. S_DRIVE_TYPE_ Table 19 on page 26 provides the definitions for the S_DRIVE_TYPE_ constant. Table 19 S_DRIVE_TYPE_ constant definitions (page 1 of 2) S_DRIVE_TYPE_UNKNOWN S_DRIVE_TYPE_RESERVED S_DRIVE_TYPE_WORM S_DRIVE_TYPE_OPTICAL S_DRIVE_TYPE_CDROM S_DRIVE_TYPE_CDROM_WRITER S_DRIVE_TYPE_TAPE S_DRIVE_TYPE_DVD_RAM S_DRIVE_TYPE_NAS S_DRIVE_TYPE_TSM S_DRIVE_TYPE_VM S_DRIVE_TYPE_FAKE S_DRIVE_TYPE_DVD_R S_DRIVE_TYPE_CD_R S_DRIVE_TYPE_DVD_ROM S_DRIVE_TYPE_EMC S_DRIVE_TYPE_UDO Meaning The drive is not recognized. The drive is not available for use by DiskXtender. The drive can read and write write-once media. The drive can read and write rewritable media. Not used. Not used. The drive can read and write tape. The drive can read and write DVD-RAM. Used for NAS media. Used for IBM Tivoli Storage Manager virtual media. Used for virtual media. Used for fake media. The drive can read and write DVD-R. Not used. The drive can read DVD-ROM. Used for EMC Centera virtual media. The drive can read UDO. 26 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

27 DxDmClient Constants Table 19 S_DRIVE_TYPE_ constant definitions (page 2 of 2) S_DRIVE_TYPE_PDD S_DRIVE_TYPE_UDO2 S_DRIVE_TYPE_ALL Meaning The drive can read PDD. The drive can read UDO2. The drive can be used for all media types. S_FINALIZE_TYPE_ Table 20 Table 20 on page 27 provides the definitions for the S_FINALIZE_TYPE_ constant. S_FINALIZE_TYPE_ constant definitions S_FINALIZE_TYPE_UNKNOWN S_FINALIZE_TYPE_UDF S_FINALIZE_TYPE_ISO9660 Meaning The media will be finalized with an unknown file system. The media will be finalized with the UDF file system. The media will be finalized with the ISO 9660 file system. S_FS_TYPE_ Table 21 on page 27 provides the definitions for the S_FS_TYPE_ constant. Table 21 S_FS_TYPE_ constant definitions S_FS_TYPE_UNKNOWN S_FS_TYPE_OTG S_FS_TYPE_FAT S_FS_TYPE_NTFS S_FS_TYPE_HPFS S_FS_TYPE_ISO9660 S_FS_TYPE_ISO9660_JOLIET S_FS_TYPE_ISO9660_MS S_FS_TYPE_ISO9660_MS_JOLIET S_FS_TYPE_HSG S_FS_TYPE_HSG_MS S_FS_TYPE_CDAUDIO S_FS_TYPE_PHOTOCD S_FS_TYPE_TSM S_FS_TYPE_UDF S_FS_TYPE_EMC S_FS_TYPE_NAS Meaning The file system on the media is unknown. The file system on the media is OTG. Not used. Not used. Not used. Not used. Not used. Not used. Not used. Not used. Not used. Not used. Not used. The file system on the media is TSM. The file system on the media is UDF. The file system on the media is EMC Centera. The file system on the media is NAS. Media and hardware device constants 27

28 DxDmClient Constants S_FS_CLASS_ Table 22 on page 28 provides the definitions for the S_FS_CLASS_ constant. Table 22 S_FS_CLASS_ constant definitions S_FS_CLASS_OTG S_FS_CLASS_NATIVE S_FS_CLASS_UDF S_FS_CLASS_UNKNOWN Meaning OTG file system Native file system UDF file system Unknown file system S_ITEM_FILTER_ Table 23 Table 23 on page 28 provides the definitions for the S_ITEM_FILTER_ constant. S_ITEM_FILTER_ constant definitions S_ITEM_FILTER_NONE S_ITEM_FILTER_FULL_MEDIA S_ITEM_FILTER_ACTIVE_MEDIA Meaning Show all media in the list. Show only full media in the list. Show only active media (media available for file writes) in the list. S_LIB_SIDE_ Table 24 on page 28 provides the definitions for the S_LIB_SIDE_ constant. Table 24 S_LIB_SIDE_ constant definitions S_LIB_SIDE_A S_LIB_SIDE_B Meaning Library shelf side A Library shelf side B S_MEDIA_ATTRIBUTE_ Table 25 Table 25 on page 28 provides the definitions for the S_MEDIA_ATTRIBUTE_ constant. S_MEDIA_ATTRIBUTE_ constant definitions S_MEDIA_ATTRIBUTE_READONLY S_MEDIA_ATTRIBUTE_WRITEONCE S_MEDIA_ATTRIBUTE_COMPRESSED S_MEDIA_ATTRIBUTE_STREAMS_NOT_SUPPORTED S_MEDIA_ATTRIBUTE_RETENTION S_MEDIA_ATTRIBUTE_NAS_AGGREGATION S_MEDIA_ATTRIBUTE_WORM_CONVERTABLE Meaning The media is read-only. Media blocks cannot be rewritten. This applies for WORM and tape media. Files written to the media are compressed. File streams are not supported on the media. NAS media that supports file retention. The media is Aggregate NAS media. Files written to the media cannot be edited. The media can be converted from standard media to WORM media. 28 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

29 DxDmClient Constants S_MEDIA_CLASS_ Table 26 Table 26 on page 29 provides the definitions for the S_MEDIA_CLASS_ constant. S_MEDIA_CLASS_ constant definitions S_MEDIA_CLASS_UNKNOWN S_MEDIA_CLASS_ORIGINAL S_MEDIA_CLASS_COPY S_MEDIA_CLASS_BLANK S_MEDIA_CLASS_UNFORMATTED S_MEDIA_CLASS_FOREIGN S_MEDIA_CLASS_DUPLICATE S_MEDIA_CLASS_CORRUPT S_MEDIA_CLASS_CLEANING S_MEDIA_CLASS_ALL S_MEDIA_CLASS_MASK Meaning The media class is unknown. DiskXtender does not recognize the media. The problem could be an unsupported media type or an unsupported file system. The media class is original. The media you has been prepared for use (allocated to the extended drive, formatted, and labeled), but it has not yet been assigned to a media group. The media class is copy. The media is being used as a copy of a piece of original media. The media class is blank. The media has been formatted but it has not yet been labeled. The media class is unformatted. The media has been unpackaged and placed in the defice, but it has not yet been formatted. The media class is foreign. The media has been formatted for a file system that is not supported for the media type. The media class is duplicate. The media has the same serial number as another piece of media. The media class is corrupt. The media is formatted with the UDF file system, but the media cannot be used because of problems with the media itself. Not used in DiskXtender. All classes. All valid bits for media classes. S_MEDIA_SERVICE_STATUS_ Table 27 on page 29 provides the definitions for the S_MEDIA_SERVICE_STATUS_ constant. Table 27 S_MEDIA_SERVICE_STATUS_ constant definitions S_MEDIA_SERVICE_STATUS_OFFLINE S_MEDIA_SERVICE_STATUS_ONLINE S_MEDIA_SERVICE_STATUS_SETTING_OFFLINE S_MEDIA_SERVICE_STATUS_SETTING_ONLINE S_MEDIA_SERVICE_STATUS_ERROR S_MEDIA_SERVICE_STATUS_DISCONNECTED Meaning The media service is offline. The media service is online. The media service is being set offline. The media service is being set online. The media service is in an error state. The media service is not available. Media and hardware device constants 29

30 DxDmClient Constants S_MEDIA_SERVICE_TYPE_ Table 28 on page 30 provides the definitions for the S_MEDIA_SERVICE_TYPE_ constant. Table 28 S_MEDIA_SERVICE_TYPE_ constant definitions S_MEDIA_SERVICE_TYPE_UNKNOWN S_MEDIA_SERVICE_TYPE_OTGMS S_MEDIA_SERVICE_TYPE_NAS S_MEDIA_SERVICE_TYPE_ACSLS S_MEDIA_SERVICE_TYPE_TSM S_MEDIA_SERVICE_TYPE_SMARTMEDIA S_MEDIA_SERVICE_TYPE_TRMM S_MEDIA_SERVICE_TYPE_EMC S_MEDIA_SERVICE_TYPE_AS Meaning The media service type is unknown. The media service is an EMC DiskXtender MediaStor TM media service. The media service is a NAS media service. The media service is a StorageTek ACSLS media service. The media service is a TSM media service. Not available. Not available. The media service is an EMC Centera media service. Not available. S_MEDIA_STATUS_ Table 29 Table 29 on page 30 provides the definitions for the S_MEDIA_STATUS_ constant. S_MEDIA_STATUS_ constant definitions S_MEDIA_STATUS_OFFLINE S_MEDIA_STATUS_ONLINE S_MEDIA_STATUS_SETTING_OFFLINE S_MEDIA_STATUS_SETTING_ONLINE S_MEDIA_STATUS_ERROR S_MEDIA_STATUS_INVENTORY_PENDING S_MEDIA_STATUS_INVENTORY_INPROGRESS S_MEDIA_STATUS_INVENTORY_FAILED S_MEDIA_STATUS_NOT_IN_MEDIA_POOL S_MEDIA_STATUS_SETTING_ERROR Meaning The media is offline. The media is online. The media is being set offline. The media is being set online. The media is in an error state. The media is pending inventory. The media inventory is in progress. The media inventory failed. The media has not been allocated to an extended drive. The media is being set to an error state. 30 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

31 DxDmClient Constants S_MEDIA_TYPE_ Table 30 Table 30 on page 31 provides the definitions for the S_MEDIA_TYPE_ constant. S_MEDIA_TYPE_ constant definitions S_MEDIA_TYPE_UNKNOWN S_MEDIA_TYPE_WORM S_MEDIA_TYPE_OPTICAL S_MEDIA_TYPE_TAPE S_MEDIA_TYPE_CDROM S_MEDIA_TYPE_DVD_RAM S_MEDIA_TYPE_NAS S_MEDIA_TYPE_TSM S_MEDIA_TYPE_DVD_ROM S_MEDIA_TYPE_VM S_MEDIA_TYPE_FAKE S_MEDIA_TYPE_DVD_R S_MEDIA_TYPE_CD_R S_MEDIA_TYPE_TAPE_WORM S_MEDIA_TYPE_EMC S_MEDIA_TYPE_NAS_WORM S_MEDIA_TYPE_RETENTION_NAS S_MEDIA_TYPE_UDO S_MEDIA_TYPE_UDO_WORM S_MEDIA_TYPE_UDO2 S_MEDIA_TYPE_UDO2_WORM S_MEDIA_TYPE_DVD_PLUS_R S_MEDIA_TYPE_GROUP S_MEDIA_TYPE_ANY S_MEDIA_TYPE_CLEANING Meaning The media type is unknown or unsupported. The media is WORM. The media is read-write optical. The media is tape. Not used. The media is DVD-RAM. The media is NAS. The media is TSM. The media is DVD-ROM. Not used. Not used. The media is DVD-R. Not used. The media is tape-worm. The media is EMC Centera. The media is Retained NAS. Not used. The media is UDO. The media is UDO WORM. TThe media is UDO2. The media is UDO2 WORM. The media is DVD+R. The media is a standard media group that has been added to a multi-target media groups. Not used. The media is a cleaning cartridge. Media and hardware device constants 31

32 DxDmClient Constants TASK_STATUS_ Table 31 on page 32 provides the definitions for the TASK_STATUS_ constant. Table 31 TASK_STATUS_ constant definitions TASK_STATUS_NONE TASK_STATUS_PENDING TASK_STATUS_INPROGRESS TASK_STATUS_ABORT_PENDING TASK_STATUS_ABORT_INPROGRESS TASK_STATUS_ABORTED TASK_STATUS_FAILED TASK_STATUS_COMPLETE TASK_STATUS_INUSE_BY_COPY TASK_STATUS_SUSPENDED Meaning There is no status to report for the task. The task is in the queue awaiting processing. The task is being processed. Abortion of the task is pending. The task is in the process of being aborted. The task was aborted. The task failed. The task completed successfully. Not used. The task has been suspended. TASK_TYPE_ Table 32 on page 32 provides the definitions for the TASK_TYPE_ constant. Table 32 TASK_TYPE_ constant definitions TASK_TYPE_NONE TASK_TYPE_ADD_TO_MEDIA_GROUP TASK_TYPE_CHANGE_MEDIA_GROUP TASK_TYPE_CHECK_DISK TASK_TYPE_COMPACT TASK_TYPE_COPY TASK_TYPE_FILE_REPORT TASK_TYPE_FORMAT TASK_TYPE_LABEL TASK_TYPE_LABEL_COPY TASK_TYPE_PREFETCH TASK_TYPE_PREFETCH_FILELIST TASK_TYPE_REMOVE_FROM_MEDIA_GROUP TASK_TYPE_RESTORE TASK_TYPE_FINALIZE TASK_TYPE_FLUSH Meaning No media task. Add media to media group task. Not used. Check disk task. Compact task. Copy task. File report task. Format task. Label task. Label copy task. Prefetch task to prefetch all files from a piece of media. Prefetch task to prefetch a list of files on the extended drive. Remove media from media group task. File restore task. Finalize task. Task for flushing files to a piece of media. 32 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

33 DxDmClient Constants Log and report constants The constants in the following sections define values for DiskXtender logs and reports. AUDIT_LOG_FILTER_ Table 33 Table 33 on page 33 provides the definitions for the AUDIT_LOG_FILTER_ constant. AUDIT_LOG_FILTER_ constant definitions AUDIT_LOG_FILTER_NONE AUDIT_LOG_FILTER_CREATES AUDIT_LOG_FILTER_DELETES AUDIT_LOG_FILTER_MODS AUDIT_LOG_FILTER_LOGON_OFF AUDIT_LOG_FILTER_REG_LOG AUDIT_LOG_FILTER_MISC AUDIT_LOG_FILTER_EVENT_LOGGING Meaning No audit log events are logged. Creation of configuration items is logged to the audit log. Deletion of configuration items is logged to the audit log. Modification of configuration items is logged to the audit log. Service stops and restarts are logged to the audit log. Updates to the DiskXtender registry log are logged to the audit log. Miscellaneous operations, such as media allocation and deallocation, metadata import and export, and copy media promotion are logged to the audit log. Enable event logging in the Windows log file. DX_TRACE_ Table 34 on page 33 provides the definitions for the DX_TRACE_ constant. Table 34 DX_TRACE_ constant definitions (page 1 of 2) DX_TRACE_SERVER_ALL DX_TRACE_SERVER_BACKTHREAD DX_TRACE_SERVER_CHECK_DISK DX_TRACE_SERVER_COPY DX_TRACE_SERVER_COMPACT DX_TRACE_SERVER_DRIVE DX_TRACE_SERVER_FETCH DX_TRACE_SERVER_FORMAT DX_TRACE_SERVER_FILE_REPORT DX_TRACE_SERVER_LABEL DX_TRACE_SERVER_JUKEBOX DX_TRACE_SERVER_MOVE DX_TRACE_SERVER_PREFETCH DX_TRACE_SERVER_RESTORE Meaning All server messages are traced. Server background thread messages are traced. Server check disk messages are traced. Server media copy messages are traced. Server media compaction messages are traced. Server drive messages are traced. Server file fetch messages are traced. Server media format messages are traced. Server media file report messages are traced. Server media label messages are traced. Server library messages are traced. Server file migration messages are traced. Server media prefetch messages are traced. Server file restore messages are traced. Log and report constants 33

34 DxDmClient Constants Table 34 DX_TRACE_ constant definitions (page 2 of 2) DX_TRACE_SERVER_SEMAPHORE DX_TRACE_SERVER_SCHEDULE DX_TRACE_SERVER_TOWER DX_TRACE_SERVER_TRANS_LOG_FLUSH DX_TRACE_RPC_ALL DX_TRACE_RPC_LOGON DX_TRACE_RPC_AGENT DX_TRACE_RPC_DRIVE DX_TRACE_RPC_FETCH DX_TRACE_RPC_FILTER DX_TRACE_RPC_JUKE DX_TRACE_RPC_LOG DX_TRACE_RPC_MEDIA DX_TRACE_RPC_MIGRATION DX_TRACE_RPC_MOVEGROUP DX_TRACE_RPC_STATE DX_TRACE_RPC_SYSTEM DX_TRACE_RPC_TOWER DX_TRACE_RPC_FILE DX_TRACE_DB_ALL DX_TRACE_DB_SYSTEM DX_TRACE_DB_ARRAY DX_TRACE_DB_REGISTRY DX_TRACE_DB_SEMAPHORE Meaning Server semaphoring messages are traced. Server schedule messages are traced. Not used. Server flush transaction log messages are traced. All RPC-related messages are traced. RPC logon messages are traced. Not used. RPC drive messages are traced. RPC file fetch messages are traced. RPC extended drive messages are traced. RPC library messages are traced. RPC logging messages are traced. RPC media messages are traced. RPC file migration messages are traced. RPC media group messages are traced. RPC state messages are traced. RPC system messages are traced. Not used. RPC file messages are traced. Not used. Not used. Not used. Not used. Not used. LOG_TYPE_ Table 35 on page 34 provides the definitions for the LOG_TYPE_ constant. Table 35 LOG_TYPE_ constant definitions (page 1 of 2) LOG_TYPE_EVENT LOG_TYPE_WARNING LOG_TYPE_ERROR LOG_TYPE_DRIVE LOG_TYPE_JUKE Meaning Log for all events. Log for warnings only. Log for errors only. Not used. Not used. 34 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide

35 DxDmClient Constants Table 35 LOG_TYPE_ constant definitions (page 2 of 2) LOG_TYPE_MEDIA LOG_TYPE_PREFETCH LOG_TYPE_HISTORY_EVENT LOG_TYPE_HISTORY_WARNING LOG_TYPE_HISTORY_ERROR Meaning Not used. Not used. Not used. Not used. Not used. Message types Table 36 on page 35 provides the definitions for the message constants. Table 36 Message constant definitions (page 1 of 2) Meaning Constant MSG_XERR_STR DX error string XERR_* MSG_XERR_DESC DX error description XERR_* MSG_LM_NET_ERR Windows error strings Windows errors MSG_NT_SYSTEM_ERROR Windows error strings Windows errors MSG_AGE_FROM Age type used by rules AGE_FROM_ MSG_ALERT_TYPE Alert type GENERIC_ MSG_RPC_PROTOCOL RPC protocol type RPC_PROTOCOL_ MSG_SCHEDULE_TYPE Schedule type SCHEDULE_TYPE_ MSG_SORT_BY File sort type SORT_BY_ MSG_TASK_STATUS Task status TASK_STATUS_ MSG_TASK_TYPE Media task type TASK_TYPE_ MSG_WEEK_DAY Scheduled days WEEK_DAY_ MSG_S_DEVICE_TYPE Device type S_DEVICE_TYPE MSG_S_DRIVE_STATUS Drive status S_DRIVE_STATUS MSG_S_CFG_DRIVE_TYPE Drive type S_DRIVE_TYPE_ MSG_S_DRIVE_TYPE Drive type S_DRIVE_TYPE_ MSG_S_DRIVER_TYPE Driver type S_DRIVER_TYPE MSG_S_FILTER_STATUS Extended drive status S_FILTER_STATUS_ MSG_S_FS_TYPE File system type S_FS_TYPE_ MSG_S_INTERFACE_TYPE Interface type S_INTERFACE_TYPE MSG_S_ISS_CMD ISS commands to control drives and files on the drives Not used in DiskXtender MSG_S_LIB_CMD Storage library commands Not used in DiskXtender MSG_S_LIB_MAILSLOT_TYPE Mailslot type Not used in DiskXtender MSG_S_LIB_PROMPT Library command messages to operate media with library Not used in DiskXtender Log and report constants 35

36 DxDmClient Constants Table 36 Message constant definitions (page 2 of 2) Meaning Constant MSG_S_CFG_JUKE_PROMPT Jukebox configuration message Not used in DiskXtender MSG_S_LIB_ROTATE_TYPE Library rotation type Not used in DiskXtender MSG_S_LIB_STATUS Message about the status of the library Not used in DiskXtender MSG_S_LIB_VOLUME_TAG_TYPE Library volume type Not used in DiskXtender MSG_S_MEDIA_ATTRIBUTE Media attribute S_MEDIA_ATTRIBUTE_ MSG_S_MEDIA_CLASS Media class S_MEDIA_CLASS_ MSG_S_MEDIA_SERVICE_STATUS Media service status S_MEDIA_SERVICE_STATUS_ MSG_S_MEDIA_SERVICE_TYPE Media service type S_MEDIA_SERVICE_TYPE_ MSG_S_MEDIA_STATUS Media status S_MEDIA_STATUS_ MSG_S_MEDIA_TYPE Media type S_MEDIA_TYPE_ MSG_S_OPCODE SCSI operation codes Not used in DiskXtender MSG_S_SENSE_KEY Sense key status Not used in DiskXtender MSG_S_SHELF_STATUS Shelf status Not used in DiskXtender MSG_S_TARGET_STATUS Target status Not used in DiskXtender MSG_S_FS_CLASS File system class S_FS_CLASS_ MSG_S_FINALIZE_TYPE Finalization type S_FINALIZE_TYPE_ MSG_S_DRIVE_CLEAN Tape drive cleaning request Not used in DiskXtender MSG_S_AUDIT_OBJECT_TYPE Type of audit object S_AUDIT_OBJECT_TYPE_ MSG_S_AUDIT_OBJECT_ACTION Type of audit action S_AUDIT_OBJECT_ACTION_ RTF_ALIGN_ Table 37 on page 36 provides the definitions for the RTF_ALIGN_ constant. Table 37 RTF_ALIGN_ constant definitions RTF_ALIGN_CURRENT RTF_ALIGN_LEFT RTF_ALIGN_CENTER RTF_ALIGN_RIGHT Meaning Use current text alignment. Align text on the left of the page. Center text on the page. Align text on the right of the page. 36 EMC DiskXtender Release 6.4 Microsoft Windows Version API Reference Guide