*/
/**
- * \brief VFS Node
+ * \brief Represents a node (file or directory) in the VFS tree
*
* This structure provides the VFS with the functions required to read/write
* the file (or directory) that it represents.
Uint32 Flags; //!< File Flags
/**
- * Pointer to cached data (FS Specific)
- * \note Inode_* will free when the node is uncached this if needed
+ * \brief Pointer to cached data (FS Specific)
+ * \note The Inode_* functions will free when the node is uncached
+ * this if needed
*/
void *Data;
/**
int (*IOCtl)(struct sVFS_Node *Node, int Id, void *Data);
/**
- * }
+ * \}
*/
/**
Uint64 (*Write)(struct sVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
/**
- * }
+ * \}
*/
/**
* \param Node Pointer to this node
* \param Name Name of the new child
* \param Flags Flags to apply to the new child (directory or symlink)
- * \return Boolean success
+ * \return Zero on Success, non-zero on error (see errno.h)
*/
int (*MkNod)(struct sVFS_Node *Node, char *Name, Uint Flags);
* \return Zero on Success, non-zero on error (see errno.h)
*/
int (*Relink)(struct sVFS_Node *Node, char *OldName, char *NewName);
+
+ /**
+ * \brief Link a node to a name
+ * \param Node Pointer to this node (directory)
+ * \param Child Node to create a new link to
+ * \param NewName Name for the new link
+ * \return Zeron on success, non-zero on error (see errno.h)
+ */
+ int (*Link)(struct sVFS_Node *Node, struct sVFS_Node *Child, char *NewName);
/**
- * }
+ * \}
*/
} tVFS_Node;