STD.File.GetLogicalFileAttribute( logicalfilename, attrname )
| logicalfilename | A null-terminated string containing the name of the logical file as it is known by the DFU. |
| attrname | A null-terminated string containing the name of the file attribute to return. Possible values are recordSize, recordCount, size, clusterName, directory, owner, description, ECL, partmask, numparts, name, modified, format, job, checkSum, kind, csvSeparate, csvTerminate, csvEscape, headerLength, footerLength, rowTag, workunit, accessed, expireDays, maxRecordSize, csvQuote, blockCompressed, compressedSize, fileCrc, formatCrc, or protected. The value is case-sensitive. |
| Return: | GetLogicalFileAttribute returns returns a VARSTRING (null-terminated) value. |
The GetLogicalFileAttribute function returns the value of the attrname for the specified logicalfilename.
Note: If the logicalfilename argument references a file that does not exist, the workunit will fail with a runtime error.
Example:
IMPORT STD;
file := '~ certification::full_test_distributed';
OUTPUT(STD.File.GetLogicalFileAttribute(file,'recordSize'),NAMED('recordSize'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'recordCount'),NAMED('recordCount'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'size'),NAMED('size'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'clusterName'),NAMED('clusterName'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'directory'),NAMED('directory'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'numparts'),NAMED('numparts'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'owner'),NAMED('owner'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'description'),NAMED('description'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'ECL'),NAMED('ECL'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'partmask'),NAMED('partmask'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'name'),NAMED('name'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'modified'),NAMED('modified'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'protected'),NAMED('protected'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'format'),NAMED('format'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'job'),NAMED('job'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'checkSum'),NAMED('checkSum'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'kind'),NAMED('kind'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'csvSeparate'),NAMED('csvSeparate'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'csvTerminate'),NAMED('csvTerminate'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'csvEscape'),NAMED('csvEscape'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'headerLength'),NAMED('headerLength'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'footerLength'),NAMED('footerLength'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'rowtag'),NAMED('rowtag'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'workunit'),NAMED('workunit'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'accessed'),NAMED('accessed'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'expireDays'),NAMED('expireDays'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'maxRecordSize'),NAMED('maxRecordSize'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'csvQuote'),NAMED('csvQuote'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'blockCompressed'),NAMED('blockCompressed'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'compressedSize'),NAMED('compressedSize'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'fileCrc'),NAMED('fileCrc'));
OUTPUT(STD.File.GetLogicalFileAttribute(file,'formatCrc'),NAMED('formatCrc'));