CBFS Storage 2020 Node.js Edition

Questions / Feedback?

GetFileTagDataType Method

Retrieves the data type of a typed file tag attached to a specific vault item.

Syntax

cbdrive.getFileTagDataType(fileName, tagName, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method retrieves the data type of a typed file tag, identified by TagName, attached to the vault item (file, directory, or alternate stream) specified by FileName. If there isn't a typed file tag with the specified TagName attached to the specified vault item, this method .

The value passed for FileName must be a vault-local absolute path. The value passed for TagName may be up to 4095 characters in length (not including the null terminator).

The value returned by this method will be one of the following (except CBFSSTORAGE_TDT_RAWDATA, which is not applicable):

CBFSSTORAGE_TDT_RAWDATA0x0The tag is untyped and must be addressed by Id.

CBFSSTORAGE_TDT_BOOLEAN0x1The tag contains Boolean data and must be addressed by name.

CBFSSTORAGE_TDT_STRING0x2The tag contains String (UTF-16LE) data and must be addressed by name.

CBFSSTORAGE_TDT_DATETIME0x3The tag contains DateTime data and must be addressed by name.

CBFSSTORAGE_TDT_NUMBER0x4The tag contains numeric (signed 64-bit) data and must be addressed by name.

CBFSSTORAGE_TDT_ANSISTRING0x5The tag contains AnsiString (8-bit string) data and must be addressed by name.

Please refer to the File Tags topic for more information.

Note: This method can only be called when Active is true.

Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Storage 2020 Node.js Edition - Version 20.0 [Build 7922]