dsmRegisterFS

Edit online

The dsmRegisterFS function call registers a new file space with the IBM® Storage Protect server. Register a file space first before you can back up any data to it.

Application clients should not use the same file space names that a backup-archive client would use.

  • On UNIX or Linux®, run the df command for these names.
  • On Windows, these names are generally the volume labels that are associated with the different drives on your system.

Syntax

dsInt16_t dsmRegisterFS  (dsUint32_t         dsmHandle,
   regFSData     *regFilespaceP);

Parameters

dsUint32_t dsmHandle (I)
The handle that associates this call with a previous dsmInitEx call.
regFSData *regFilespaceP (I)
This parameter passes the name of the file space and associated information that you need to register with the IBM Storage Protect server.
Tip: The fstype field includes the prefix, API:. All file space queries display this string. For example, if the user passes myfstype for fstype in dsmRegisterFS, the actual value string on the server is returned as API:myfstype when queried. This prefix distinguishes API objects from backup-archive objects.

The usable area for fsInfo is now DSM_MAX_USER_FSINFO_LENGTH.

Return codes

The return code numbers are provided in parentheses ( ).

Table 1. Return codes for dsmRegisterFS
Return code Explanation
DSM_RC_INVALID_FSNAME (2016) Invalid file space name.
DSM_RC_INVALID_DRIVE_CHAR (2026) Drive letter is not an alphabetic character.
DSM_RC_NULL_FSNAME (2027) Null file space name.
DSM_RC_FS_ALREADY_REGED (2062) File space is already registered.
DSM_RC_WRONG_VERSION_PARM (2065) Application client's API version is different from the IBM Storage Protect library version.
DSM_RC_FSINFO_TOOLONG (2106) File space information is too long.