Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit e164bd8

Browse files
jackjansenjackjansen
committed
Documented FindFolder, GetFInfo, SetFInfo and the FInfo object.
1 parent ea79c87 commit e164bd8

2 files changed

Lines changed: 96 additions & 0 deletions

File tree

‎Doc/libmacfs.tex‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ \section{Built-in Module \sectcode{macfs}}
2828
FSSpec structure over a network.
2929
\end{funcdesc}
3030

31+
\begin{funcdesc}{FInfo}{}
32+
Create a zero-filled FInfo object.
33+
\end{funcdesc}
34+
3135
\begin{funcdesc}{ResolveAliasFile}{file}
3236
Resolve an alias file. Returns a 3-tuple \code{(\var{fsspec}, \var{isfolder},
3337
\var{aliased})} where \var{fsspec} is the resulting FSSpec object,
@@ -57,6 +61,16 @@ \section{Built-in Module \sectcode{macfs}}
5761
dialog. Return an FSSpec object and a success-indicator.
5862
\end{funcdesc}
5963

64+
\begin{funcdesc}{FindFolder}{where\, which\, create}
65+
Locates one of the ``special'' folders that MacOS knows about, such as
66+
the trash or the Preferences folder. \var{Where} is the disk to search
67+
(\code{0x8000} for the boot disk), \var{which} is the 4-char string
68+
specifying which folder to locate. Setting \var{create} causes the
69+
folder to be created if it does not exist. Returns a \code{(vrefnum,
70+
dirid)} tuple. See Inside Mac VI for a complete description, including
71+
4-char names.
72+
\end{funcdesc}
73+
6074
\subsection{FSSpec objects}
6175

6276
\renewcommand{\indexsubitem}{(FSSpec object attribute)}
@@ -93,6 +107,15 @@ \subsection{FSSpec objects}
93107
Set the 4-char creator and type of the file.
94108
\end{funcdesc}
95109

110+
\begin{funcdesc}{GetFInfo}{}
111+
Return a FInfo object describing the finder info for the file.
112+
\end{funcdesc}
113+
114+
\begin{funcdesc}{SetFInfo}{finfo}
115+
Set the finder info for the file to the values specified in the
116+
\var{finfo} object.
117+
\end{funcdesc}
118+
96119
\subsection{alias objects}
97120

98121
\renewcommand{\indexsubitem}{(alias object attribute)}
@@ -125,3 +148,28 @@ \subsection{alias objects}
125148
modifying the resource.
126149

127150

151+
\subsection{FInfo objects}
152+
153+
See Inside Mac for a complete description of what the various fields
154+
mean.
155+
156+
\renewcommand{\indexsubitem}{(FInfo object attribute)}
157+
\begin{datadesc}{Creator}
158+
The 4-char creator code of the file.
159+
\end{datadesc}
160+
161+
\begin{datadesc}{Type}
162+
The 4-char type code of the file.
163+
\end{datadesc}
164+
165+
\begin{datadesc}{Flags}
166+
The finder flags for the file as 16-bit integer.
167+
\end{datadesc}
168+
169+
\begin{datadesc}{Location}
170+
A Point giving the position of the file's icon in its folder.
171+
\end{datadesc}
172+
173+
\begin{datadesc}{Fldr}
174+
The folder the file is in (as an integer).
175+
\end{datadesc}

‎Doc/mac/libmacfs.tex‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ \section{Built-in Module \sectcode{macfs}}
2828
FSSpec structure over a network.
2929
\end{funcdesc}
3030

31+
\begin{funcdesc}{FInfo}{}
32+
Create a zero-filled FInfo object.
33+
\end{funcdesc}
34+
3135
\begin{funcdesc}{ResolveAliasFile}{file}
3236
Resolve an alias file. Returns a 3-tuple \code{(\var{fsspec}, \var{isfolder},
3337
\var{aliased})} where \var{fsspec} is the resulting FSSpec object,
@@ -57,6 +61,16 @@ \section{Built-in Module \sectcode{macfs}}
5761
dialog. Return an FSSpec object and a success-indicator.
5862
\end{funcdesc}
5963

64+
\begin{funcdesc}{FindFolder}{where\, which\, create}
65+
Locates one of the ``special'' folders that MacOS knows about, such as
66+
the trash or the Preferences folder. \var{Where} is the disk to search
67+
(\code{0x8000} for the boot disk), \var{which} is the 4-char string
68+
specifying which folder to locate. Setting \var{create} causes the
69+
folder to be created if it does not exist. Returns a \code{(vrefnum,
70+
dirid)} tuple. See Inside Mac VI for a complete description, including
71+
4-char names.
72+
\end{funcdesc}
73+
6074
\subsection{FSSpec objects}
6175

6276
\renewcommand{\indexsubitem}{(FSSpec object attribute)}
@@ -93,6 +107,15 @@ \subsection{FSSpec objects}
93107
Set the 4-char creator and type of the file.
94108
\end{funcdesc}
95109

110+
\begin{funcdesc}{GetFInfo}{}
111+
Return a FInfo object describing the finder info for the file.
112+
\end{funcdesc}
113+
114+
\begin{funcdesc}{SetFInfo}{finfo}
115+
Set the finder info for the file to the values specified in the
116+
\var{finfo} object.
117+
\end{funcdesc}
118+
96119
\subsection{alias objects}
97120

98121
\renewcommand{\indexsubitem}{(alias object attribute)}
@@ -125,3 +148,28 @@ \subsection{alias objects}
125148
modifying the resource.
126149

127150

151+
\subsection{FInfo objects}
152+
153+
See Inside Mac for a complete description of what the various fields
154+
mean.
155+
156+
\renewcommand{\indexsubitem}{(FInfo object attribute)}
157+
\begin{datadesc}{Creator}
158+
The 4-char creator code of the file.
159+
\end{datadesc}
160+
161+
\begin{datadesc}{Type}
162+
The 4-char type code of the file.
163+
\end{datadesc}
164+
165+
\begin{datadesc}{Flags}
166+
The finder flags for the file as 16-bit integer.
167+
\end{datadesc}
168+
169+
\begin{datadesc}{Location}
170+
A Point giving the position of the file's icon in its folder.
171+
\end{datadesc}
172+
173+
\begin{datadesc}{Fldr}
174+
The folder the file is in (as an integer).
175+
\end{datadesc}

0 commit comments

Comments
 (0)