home *** CD-ROM | disk | FTP | other *** search
/ Mac Magazin/MacEasy 72 / maccd 72.iso / online / NetFinder 2.1.2 ƒ / NetFinder Script Components / Modules / Module Doco / Inside InterfaceLib Module.txt < prev    next >
Encoding:
Text File  |  2000-04-08  |  11.0 KB  |  688 lines  |  [TEXT/R*ch]
  1. This documentation is incomplete... 
  2.  
  3. For more info you may wish to refer to Inside Macintosh by Apple.
  4. Most routines in here roughtly mirror the calling conventions
  5. of the ones provided by Apple for the MacOS.
  6. =====================================
  7.  
  8. (c) 2000 Peter Li, All Rights Reserved.
  9.  
  10.  
  11. Standard Lib Routines
  12. =====================
  13.  
  14. NFLoadModuleConstants();
  15.  
  16. Description: Loads constants used by InterfaceLib exported routines to make
  17.              scripts more readable.
  18. Parameters:  none
  19. Returns:     null
  20.  
  21. -----------------------------
  22.  
  23. NFGetModuleVersion();
  24.  
  25. Description: Returns the version of the current set of exported routines by
  26.              NetFinder.
  27. Parameters:  none
  28. Returns:     null
  29.  
  30.  
  31.  
  32. MacOS Routines
  33. ==============
  34. For more info on these routines see Inside Macintosh references by Apple.
  35. These routines are very similary.
  36. ==============
  37.  
  38. SysBeep([int inNumBeeps]);
  39.  
  40. Description: 
  41.  
  42. Parameters:  none
  43.  
  44. Returns:     null
  45.  
  46. -----------------------------
  47.  
  48. [struct like StandardFileReply] = StandardPutFile([string inPrompt][,string inDefaultName]);
  49.  
  50. Description: 
  51.  
  52. Parameters:  none
  53.  
  54. Returns:     null
  55.  
  56. -----------------------------
  57.  
  58. [struct like StandardFileReply] = StandardGetFile([array [string inOSType]{0,4}]);
  59.  
  60. Description: 
  61.  
  62. Parameters:  none
  63.  
  64. Returns:     null
  65.  
  66. -----------------------------
  67.  
  68. int = FindFolder(int inVRefNum, int inFolderType, int inCreateFolder, 
  69.                  int* outVRefNum, int* outDirID);
  70.  
  71. Description: 
  72.  
  73. Parameters:  none
  74.  
  75. Returns:     null
  76.  
  77. -----------------------------
  78.  
  79. int = FSMakeFSSpec(int inVRefNum, int inParID, string inName, struct outSpec);
  80.  
  81. Description: 
  82.  
  83. Parameters:  none
  84.  
  85. Returns:     null
  86.  
  87. -----------------------------
  88.  
  89. int = FlushVol(string inName, int inVRefNum);
  90.  
  91. Description: 
  92.  
  93. Parameters:  none
  94.  
  95. Returns:     null
  96.  
  97. -----------------------------
  98.  
  99. int = FSClose(int inRefNum);
  100.  
  101. Description: 
  102.  
  103. Parameters:  none
  104.  
  105. Returns:     null
  106.  
  107. -----------------------------
  108.  
  109. int = FSRead(int inRefNum, int* ioLen, string* outStr);
  110.  
  111. Description: 
  112.  
  113. Parameters:  none
  114.  
  115. Returns:     null
  116.  
  117. -----------------------------
  118.  
  119. int = FSWrite(int inRefNum, int* ioLen, string inStr);
  120.  
  121. Description: 
  122.  
  123. Parameters:  none
  124.  
  125. Returns:     null
  126.  
  127. -----------------------------
  128.  
  129. int = GetEOF(int inRefNum, int* outEOF);
  130.  
  131. Description: 
  132.  
  133. Parameters:  none
  134.  
  135. Returns:     null
  136.  
  137. -----------------------------
  138.  
  139. int = SetEOF(int inRefNum, int inEOF);
  140.  
  141. Description: 
  142.  
  143. Parameters:  none
  144.  
  145. Returns:     null
  146.  
  147. -----------------------------
  148.  
  149. int = GetFPos(int inRefNum, int* outFilePos);
  150.  
  151. Description: 
  152.  
  153. Parameters:  none
  154.  
  155. Returns:     null
  156.  
  157. -----------------------------
  158.  
  159. int = SetFPos(int inRefNum, int inPosMode, int inPosOff);
  160.  
  161. Description: 
  162.  
  163. Parameters:  none
  164.  
  165. Returns:     null
  166.  
  167. -----------------------------
  168.  
  169. int = FSpOpenDF(struct inSpec, int inPerm, int* outRefNum);
  170.  
  171. Description: 
  172.  
  173. Parameters:  none
  174.  
  175. Returns:     null
  176.  
  177. -----------------------------
  178.  
  179. int = FSpOpenRF(struct inSpec, int inPerm, int* outRefNum);
  180.  
  181. Description: 
  182.  
  183. Parameters:  none
  184.  
  185. Returns:     null
  186.  
  187. -----------------------------
  188.  
  189. int = FSpCreate(struct inSpec, string inCreator, string inType [, int inScriptCode]);
  190.  
  191. Description: 
  192.  
  193. Parameters:  none
  194.  
  195. Returns:     null
  196.  
  197. -----------------------------
  198.  
  199. int = FSpDirCreate(struct inSpec, int inScriptCode, int* outDirNum);
  200.  
  201. Description: 
  202.  
  203. Parameters:  none
  204.  
  205. Returns:     null
  206.  
  207. -----------------------------
  208.  
  209. int = FSpDelete(struct inSpec);
  210.  
  211. Description: 
  212.  
  213. Parameters:  none
  214.  
  215. Returns:     null
  216.  
  217. -----------------------------
  218.  
  219. int = FSpSetFLock(struct inSpec);
  220.  
  221. Description: 
  222.  
  223. Parameters:  none
  224.  
  225. Returns:     null
  226.  
  227. -----------------------------
  228.  
  229. int = FSpRstFLock(struct inSpec);
  230.  
  231. Description: 
  232.  
  233. Parameters:  none
  234.  
  235. Returns:     null
  236.  
  237. -----------------------------
  238.  
  239. int = FSpRename(struct inSpec, string inNewName);
  240.  
  241. Description: 
  242.  
  243. Parameters:  none
  244.  
  245. Returns:     null
  246.  
  247. -----------------------------
  248.  
  249. int = FSpCatMove(struct inFromSpec, struct inToSpec);
  250.  
  251. Description: 
  252.  
  253. Parameters:  none
  254.  
  255. Returns:     null
  256.  
  257. -----------------------------
  258.  
  259. int = FSpExchangeFiles(struct inSpecOne, struct inSpecTwo);
  260.  
  261. Description: 
  262.  
  263. Parameters:  none
  264.  
  265. Returns:     null
  266.  
  267.  
  268.  
  269.  
  270. MoreFiles Routines
  271. ==================
  272. These are not standard MacOS routines, they are provided by Apple DTS
  273. (Developer Tech Support). These are also available from Apple.
  274. ==================
  275.  
  276. int = FSpGetFullPath(struct inSpec, string* outFullPath);
  277.  
  278. Description: 
  279.  
  280. Parameters:  none
  281.  
  282. Returns:     null
  283.  
  284. -----------------------------
  285.  
  286. int = FSpDTXGetAPPL(string inVolName, int inVRefNum, string inCreator,
  287.                     int inSearchCat, struct* outSpec);
  288.  
  289. Description: 
  290.  
  291. Parameters:  none
  292.  
  293. Returns:     null
  294.  
  295. -----------------------------
  296.  
  297. int = FSpDTSetComment(struct inSpec, string inComments);
  298.  
  299. Description: 
  300.  
  301. Parameters:  none
  302.  
  303. Returns:     null
  304.  
  305. -----------------------------
  306.  
  307. int = FSpDTGetComment(struct inSpec, string* outComments);
  308.  
  309. Description: 
  310.  
  311. Parameters:  none
  312.  
  313. Returns:     null
  314.  
  315. -----------------------------
  316.  
  317. int = FSpDTCopyComment(struct inSpecFrom, struct inSpecTo);
  318.  
  319. Description: 
  320.  
  321. Parameters:  none
  322.  
  323. Returns:     null
  324.  
  325. -----------------------------
  326.  
  327. int = FSpGetDirectoryID(struct inSpec, int* outDirID, int* outIsDir);
  328.  
  329. Description: 
  330.  
  331. Parameters:  none
  332.  
  333. Returns:     null
  334.  
  335. -----------------------------
  336.  
  337. int = FSpGetFileSize(struct inSpec, int* outDataSize, int* outRsrcSize);
  338.  
  339. Description: 
  340.  
  341. Parameters:  none
  342.  
  343. Returns:     null
  344.  
  345. -----------------------------
  346.  
  347. int = FSpBumpDate(struct inSpec);
  348.  
  349. Description: 
  350.  
  351. Parameters:  none
  352.  
  353. Returns:     null
  354.  
  355. -----------------------------
  356.  
  357. int = FSpChangeCreatorType(struct inSpec, string inCreator, string inType);
  358.  
  359. Description: 
  360.  
  361. Parameters:  none
  362.  
  363. Returns:     null
  364.  
  365. -----------------------------
  366.  
  367. int = FSpSetIsInvisible(struct inSpec);
  368.  
  369. Description: 
  370.  
  371. Parameters:  none
  372.  
  373. Returns:     null
  374.  
  375. -----------------------------
  376.  
  377. int = FSpClearIsInvisible(struct inSpec);
  378.  
  379. Description: 
  380.  
  381. Parameters:  none
  382.  
  383. Returns:     null
  384.  
  385. -----------------------------
  386.  
  387. int = FSpSetNameLocked(struct inSpec);
  388.  
  389. Description: 
  390.  
  391. Parameters:  none
  392.  
  393. Returns:     null
  394.  
  395. -----------------------------
  396.  
  397. int = FSpClearNameLocked(struct inSpec);
  398.  
  399. Description: 
  400.  
  401. Parameters:  none
  402.  
  403. Returns:     null
  404.  
  405. -----------------------------
  406.  
  407. int = FSpSetIsStationery(struct inSpec);
  408.  
  409. Description: 
  410.  
  411. Parameters:  none
  412.  
  413. Returns:     null
  414.  
  415. -----------------------------
  416.  
  417. int = FSpClearIsStationery(struct inSpec);
  418.  
  419. Description: 
  420.  
  421. Parameters:  none
  422.  
  423. Returns:     null
  424.  
  425. -----------------------------
  426.  
  427. int = FSpSetHasCustomIcon(struct inSpec);
  428.  
  429. Description: 
  430.  
  431. Parameters:  none
  432.  
  433. Returns:     null
  434.  
  435. -----------------------------
  436.  
  437. int = FSpClearHasCustomIcon(struct inSpec);
  438.  
  439. Description: 
  440.  
  441. Parameters:  none
  442.  
  443. Returns:     null
  444.  
  445. -----------------------------
  446.  
  447. int = FSpClearHasBeenInited(struct inSpec);
  448.  
  449. Description: 
  450.  
  451. Parameters:  none
  452.  
  453. Returns:     null
  454.  
  455. -----------------------------
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464. ============
  465. Available Constants (after constant are loaded)
  466. ============
  467.  
  468.         /* Script.h */
  469.             /* ScriptCode */
  470.         VALOF(smSystemScript),
  471.         VALOF(smCurrentScript),
  472.         VALOF(smAllScripts),
  473.         
  474.         /* File.h */
  475.         VALOF(fsCurPerm),
  476.         VALOF(fsRdPerm),
  477.         VALOF(fsWrPerm),
  478.         VALOF(fsRdWrPerm),
  479.         VALOF(fsRdWrShPerm),
  480.         
  481.         VALOF(ioDirMask),
  482.         
  483.         VALOF(fsRtParID),
  484.         VALOF(fsRtDirID),
  485.         
  486.         VALOF(fsAtMark),
  487.         VALOF(fsFromStart),
  488.         VALOF(fsFromLEOF),
  489.         VALOF(fsFromMark),
  490.         
  491.         /* Finder.h */
  492.         VALOF(kIsOnDesk),
  493.         VALOF(kIsShared),
  494.         VALOF(kHasNoINITs),
  495.         VALOF(kHasBeenInited),
  496.         VALOF(kHasCustomIcon),
  497.         VALOF(kIsStationery),
  498.         VALOF(kNameLocked),
  499.         VALOF(kHasBundle),
  500.         VALOF(kIsInvisible),
  501.         VALOF(kIsAlias),
  502.         
  503.         /* Folders.h */
  504.         VALOF(kOnSystemDisk),
  505.         
  506.         VALOF(kCreateFolder),
  507.         VALOF(kDontCreateFolder),
  508.         
  509.             /* Folder Types */
  510.                 /* "original" */
  511.         VALOF(kSystemFolderType),
  512.         VALOF(kDesktopFolderType),
  513.         VALOF(kTrashFolderType),
  514.         VALOF(kWhereToEmptyTrashFolderType),
  515.         VALOF(kPrintMonitorDocsFolderType),
  516.         VALOF(kStartupFolderType),
  517.         VALOF(kShutdownFolderType),
  518.         VALOF(kAppleMenuFolderType),
  519.         VALOF(kControlPanelFolderType),
  520.         VALOF(kExtensionFolderType),
  521.         VALOF(kFontsFolderType),
  522.         VALOF(kPreferencesFolderType),
  523.         VALOF(kTemporaryFolderType),
  524.                 /* "new" */
  525.         VALOF(kExtensionDisabledFolderType),
  526.         VALOF(kControlPanelDisabledFolderType),
  527.         VALOF(kSystemExtensionDisabledFolderType),
  528.         VALOF(kStartupItemsDisabledFolderType),
  529.         VALOF(kShutdownItemsDisabledFolderType),
  530.         VALOF(kApplicationsFolderType),
  531.         VALOF(kDocumentsFolderType),
  532.         
  533.         VALOF(kVolumeRootFolderType),
  534.         VALOF(kChewableItemsFolderType),
  535.         VALOF(kApplicationSupportFolderType),
  536.         VALOF(kTextEncodingsFolderType),
  537.         VALOF(kStationeryFolderType),
  538.         VALOF(kOpenDocFolderType),
  539.         VALOF(kOpenDocShellPlugInsFolderType),
  540.         VALOF(kEditorsFolderType),
  541.         VALOF(kOpenDocEditorsFolderType),
  542.         VALOF(kOpenDocLibrariesFolderType),
  543.         VALOF(kGenEditorsFolderType),
  544.         VALOF(kHelpFolderType),
  545.         VALOF(kInternetPlugInFolderType),
  546.         VALOF(kModemScriptsFolderType),
  547.         VALOF(kPrinterDescriptionFolderType),
  548.         VALOF(kPrinterDriverFolderType),
  549.         VALOF(kScriptingAdditionsFolderType),
  550.         VALOF(kSharedLibrariesFolderType),
  551.         VALOF(kVoicesFolderType),
  552.         VALOF(kControlStripModulesFolderType),
  553.         VALOF(kAssistantsFolderType),
  554.         VALOF(kUtilitiesFolderType),
  555.         VALOF(kAppleExtrasFolderType),
  556.         VALOF(kContextualMenuItemsFolderType),
  557.         VALOF(kMacOSReadMesFolderType),
  558.         VALOF(kALMModulesFolderType),
  559.         VALOF(kALMPreferencesFolderType),
  560.         VALOF(kALMLocationsFolderType),
  561.         VALOF(kColorSyncProfilesFolderType),
  562.         VALOF(kThemesFolderType),
  563.         VALOF(kFavoritesFolderType),
  564.         VALOF(kInternetFolderType),
  565.         VALOF(kAppearanceFolderType),
  566.         VALOF(kSoundSetsFolderType),
  567.         VALOF(kDesktopPicturesFolderType),
  568.         VALOF(kInternetSearchSitesFolderType),
  569.         VALOF(kFindSupportFolderType),
  570.         VALOF(kFindByContentFolderType),
  571.         VALOF(kInstallerLogsFolderType),
  572.         VALOF(kScriptsFolderType),
  573.         VALOF(kFolderActionsFolderType),
  574.         VALOF(kLauncherItemsFolderType),
  575.         VALOF(kRecentApplicationsFolderType),
  576.         VALOF(kRecentDocumentsFolderType),
  577.         VALOF(kRecentServersFolderType),
  578.         VALOF(kSpeakableItemsFolderType),
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.  
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619. int = ();
  620.  
  621. Description: 
  622.  
  623. Parameters:  none
  624.  
  625. Returns:     null
  626.  
  627. -----------------------------
  628.  
  629. int = ();
  630.  
  631. Description: 
  632.  
  633. Parameters:  none
  634.  
  635. Returns:     null
  636.  
  637. -----------------------------
  638.  
  639. int = ();
  640.  
  641. Description: 
  642.  
  643. Parameters:  none
  644.  
  645. Returns:     null
  646.  
  647. -----------------------------
  648.  
  649. int = ();
  650.  
  651. Description: 
  652.  
  653. Parameters:  none
  654.  
  655. Returns:     null
  656.  
  657. -----------------------------
  658.  
  659. int = ();
  660.  
  661. Description: 
  662.  
  663. Parameters:  none
  664.  
  665. Returns:     null
  666.  
  667. -----------------------------
  668.  
  669. int = ();
  670.  
  671. Description: 
  672.  
  673. Parameters:  none
  674.  
  675. Returns:     null
  676.  
  677. -----------------------------
  678.  
  679. int = ();
  680.  
  681. Description: 
  682.  
  683. Parameters:  none
  684.  
  685. Returns:     null
  686.  
  687. -----------------------------
  688.