Information Catalog Manager Programming Guide and Reference

FLGMdisExport

Retrieves MDIS-conforming metadata from the information catalog and translates it to an MDIS-conforming file. The information catalog from which you export MDIS metadata is not limited to containing MDIS metadata, but FLGMdisExport exports only MDIS-conforming metadata.

Authorization

Administrator or authorized user

Syntax 



APIRET  APIENTRY   FLGExport( PSZ              pszTagFileName,
                              PSZ              pszLogFileName,
                              PSZ              pszObjTypeName,
                              PSZ              pszObjectName,
                              PFLGEXTCODE      pExtCode );

Parameters

pszTagFileName (PSZ) -- input
Name of the output tag language file. This parameter is required.

This parameter contains the drive, directory path, and file name, and must be valid for a file allocation table (FAT) or HPFS file. The target drive for this file must be a fixed disk. If you type only the file name, the Information Catalog Manager places the MDIS-conforming file on the drive and path pointed to by the DGWPATH environment variable.

The target MDIS-conforming file must not exist; the Information Catalog Manager does not overwrite existing files.

The file name and extension (excluding the drive and directories) cannot exceed 240 characters. The entire MDIS tag file name cannot exceed 259 characters.

pszLogFileName (PSZ) -- input
Points to the name of the log file. This parameter is required.

This parameter contains the drive, directory path, and file name, and must be valid for a FAT or HPFS file. The target drive for the log file must be a fixed disk. The log file name cannot exceed 259 characters. If you specify only a file name, the Information Catalog Manager places the log file on the drive and path pointed to by the DGWPATH environment variable.

If the log file specified in this parameter does not exist, a new file is created. If the log file specified in this parameter already exists, then the FLGMdisExport API call appends to it.

pszObjTypeName (PSZ) -- input
Specifies one of the following MDIS object types that you want to export:

The object type name is not case sensitive.

pszObjectName (PSZ) -- input
Specifies the objects you want to export. Depending on the object type you specified with the pszObjTypeName parameter, the value for pszObjectName is from three to five property values, separated by periods (.).

pszObjTypeName
pszObjectName

Database
ServerName.DatabaseName.OwnerName

Dimension
ServerName.DatabaseName.OwnerName.DimensionName

Subschema
ServerName.DatabaseName.OwnerName.SubschemaName

Record
ServerName.DatabaseName.OwnerName.RecordName

Element
ServerName.DatabaseName.OwnerName.RecordName.ElementName

In this list, the parts of the name are represented with their MDIS name. To find the equivalent Information Catalog Manager names, refer to Appendix B in the Information Catalog Manager Administration Guide.

  1. Find the table for the object type you are exporting.
  2. Find the MDIS name in the Maps to MDIS name column.
  3. Find the equivalent Information Catalog Manager names in the Property name and Property short name columns.

For each part, enter the value of the named property for the object you want to export. You can use an asterisk (*) as a wildcard within, or instead of, any of the parts. If you enter nothing for a required part, the Information Catalog Manager uses the not-applicable symbol when searching for objects to export. (The not-applicable symbol is a hyphen unless you identified a different symbol when you created the information catalog.) If you enter nothing for an optional part, the Information Catalog Manager uses a null character when searching for objects to export.

pExtCode (PFLGEXTCODE) -- output
Points to an extended code associated with the reason code. See Appendix D, Information Catalog Manager reason codes to see if a meaningful extended code is associated with the returned reason code.

Reason code (APIRET)
Represents the execution result of this API call.

See Appendix D, Information Catalog Manager reason codes for an explanation of the returned reason codes.

[ Top of Page | Previous Page | Next Page ]