FileSystem.xml 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592
  1. <Type Name="FileSystem" FullName="Urho.FileSystem">
  2. <TypeSignature Language="C#" Value="public class FileSystem : Urho.UrhoObject" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FileSystem extends Urho.UrhoObject" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.UrhoObject</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. Subsystem for file and directory operations and access control.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public FileSystem (IntPtr handle);" />
  21. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  22. <MemberType>Constructor</MemberType>
  23. <AssemblyInfo>
  24. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  25. </AssemblyInfo>
  26. <Parameters>
  27. <Parameter Name="handle" Type="System.IntPtr" />
  28. </Parameters>
  29. <Docs>
  30. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  31. <summary>Constructs a new instance of FileSystem, given a raw pointer to an unmanaged object</summary>
  32. <remarks>
  33. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  34. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  35. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  36. </remarks>
  37. </Docs>
  38. </Member>
  39. <Member MemberName=".ctor">
  40. <MemberSignature Language="C#" Value="public FileSystem (Urho.Context context);" />
  41. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  42. <MemberType>Constructor</MemberType>
  43. <AssemblyInfo>
  44. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  45. </AssemblyInfo>
  46. <Parameters>
  47. <Parameter Name="context" Type="Urho.Context" />
  48. </Parameters>
  49. <Docs>
  50. <param name="context">The context that this object will be attached to.</param>
  51. <summary>Creates an instance of FileSystem that is attached to an execution context.</summary>
  52. <remarks>
  53. <para>This creates an instance of FileSystem attached to the specified execution context.</para>
  54. </remarks>
  55. </Docs>
  56. </Member>
  57. <Member MemberName=".ctor">
  58. <MemberSignature Language="C#" Value="public FileSystem (Urho.UrhoObjectFlag emptyFlag);" />
  59. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  60. <MemberType>Constructor</MemberType>
  61. <AssemblyInfo>
  62. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  63. </AssemblyInfo>
  64. <Parameters>
  65. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  66. </Parameters>
  67. <Docs>
  68. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  69. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  70. <remarks>
  71. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  72. <para>This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.</para>
  73. <para>You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.</para>
  74. </remarks>
  75. </Docs>
  76. </Member>
  77. <Member MemberName="BaseType">
  78. <MemberSignature Language="C#" Value="public override Urho.StringHash BaseType { get; }" />
  79. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash BaseType" />
  80. <MemberType>Property</MemberType>
  81. <AssemblyInfo>
  82. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  83. </AssemblyInfo>
  84. <ReturnValue>
  85. <ReturnType>Urho.StringHash</ReturnType>
  86. </ReturnValue>
  87. <Docs>
  88. <summary>Urho's type system base type.</summary>
  89. <value>StringHash representing the base type for this Urho type.</value>
  90. <remarks>This returns the Urho type system base type and is surfaced for low-level Urho code.</remarks>
  91. </Docs>
  92. </Member>
  93. <Member MemberName="CheckAccess">
  94. <MemberSignature Language="C#" Value="public bool CheckAccess (string pathName);" />
  95. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool CheckAccess(string pathName) cil managed" />
  96. <MemberType>Method</MemberType>
  97. <AssemblyInfo>
  98. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  99. </AssemblyInfo>
  100. <ReturnValue>
  101. <ReturnType>System.Boolean</ReturnType>
  102. </ReturnValue>
  103. <Parameters>
  104. <Parameter Name="pathName" Type="System.String" />
  105. </Parameters>
  106. <Docs>
  107. <param name="pathName">To be added.</param>
  108. <summary>
  109. Check if a path is allowed to be accessed. If no paths are registered, all are allowed.
  110. </summary>
  111. <returns>To be added.</returns>
  112. <remarks>To be added.</remarks>
  113. </Docs>
  114. </Member>
  115. <Member MemberName="Copy">
  116. <MemberSignature Language="C#" Value="public bool Copy (string srcFileName, string destFileName);" />
  117. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Copy(string srcFileName, string destFileName) cil managed" />
  118. <MemberType>Method</MemberType>
  119. <AssemblyInfo>
  120. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  121. </AssemblyInfo>
  122. <ReturnValue>
  123. <ReturnType>System.Boolean</ReturnType>
  124. </ReturnValue>
  125. <Parameters>
  126. <Parameter Name="srcFileName" Type="System.String" />
  127. <Parameter Name="destFileName" Type="System.String" />
  128. </Parameters>
  129. <Docs>
  130. <param name="srcFileName">To be added.</param>
  131. <param name="destFileName">To be added.</param>
  132. <summary>
  133. Copy a file. Return true if successful.
  134. </summary>
  135. <returns>To be added.</returns>
  136. <remarks>To be added.</remarks>
  137. </Docs>
  138. </Member>
  139. <Member MemberName="CreateDir">
  140. <MemberSignature Language="C#" Value="public bool CreateDir (string pathName);" />
  141. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool CreateDir(string pathName) cil managed" />
  142. <MemberType>Method</MemberType>
  143. <AssemblyInfo>
  144. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  145. </AssemblyInfo>
  146. <ReturnValue>
  147. <ReturnType>System.Boolean</ReturnType>
  148. </ReturnValue>
  149. <Parameters>
  150. <Parameter Name="pathName" Type="System.String" />
  151. </Parameters>
  152. <Docs>
  153. <param name="pathName">To be added.</param>
  154. <summary>
  155. Create a directory.
  156. </summary>
  157. <returns>To be added.</returns>
  158. <remarks>To be added.</remarks>
  159. </Docs>
  160. </Member>
  161. <Member MemberName="CurrentDir">
  162. <MemberSignature Language="C#" Value="public string CurrentDir { get; }" />
  163. <MemberSignature Language="ILAsm" Value=".property instance string CurrentDir" />
  164. <MemberType>Property</MemberType>
  165. <AssemblyInfo>
  166. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  167. </AssemblyInfo>
  168. <ReturnValue>
  169. <ReturnType>System.String</ReturnType>
  170. </ReturnValue>
  171. <Docs>
  172. <summary>
  173. Return the absolute current working directory.
  174. </summary>
  175. <value>To be added.</value>
  176. <remarks>To be added.</remarks>
  177. </Docs>
  178. </Member>
  179. <Member MemberName="Delete">
  180. <MemberSignature Language="C#" Value="public bool Delete (string fileName);" />
  181. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Delete(string fileName) cil managed" />
  182. <MemberType>Method</MemberType>
  183. <AssemblyInfo>
  184. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  185. </AssemblyInfo>
  186. <ReturnValue>
  187. <ReturnType>System.Boolean</ReturnType>
  188. </ReturnValue>
  189. <Parameters>
  190. <Parameter Name="fileName" Type="System.String" />
  191. </Parameters>
  192. <Docs>
  193. <param name="fileName">To be added.</param>
  194. <summary>
  195. Delete a file. Return true if successful.
  196. </summary>
  197. <returns>To be added.</returns>
  198. <remarks>To be added.</remarks>
  199. </Docs>
  200. </Member>
  201. <Member MemberName="DirExists">
  202. <MemberSignature Language="C#" Value="public bool DirExists (string pathName);" />
  203. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool DirExists(string pathName) cil managed" />
  204. <MemberType>Method</MemberType>
  205. <AssemblyInfo>
  206. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  207. </AssemblyInfo>
  208. <ReturnValue>
  209. <ReturnType>System.Boolean</ReturnType>
  210. </ReturnValue>
  211. <Parameters>
  212. <Parameter Name="pathName" Type="System.String" />
  213. </Parameters>
  214. <Docs>
  215. <param name="pathName">To be added.</param>
  216. <summary>
  217. Check if a directory exists.
  218. </summary>
  219. <returns>To be added.</returns>
  220. <remarks>To be added.</remarks>
  221. </Docs>
  222. </Member>
  223. <Member MemberName="ExecuteConsoleCommands">
  224. <MemberSignature Language="C#" Value="public bool ExecuteConsoleCommands { get; set; }" />
  225. <MemberSignature Language="ILAsm" Value=".property instance bool ExecuteConsoleCommands" />
  226. <MemberType>Property</MemberType>
  227. <AssemblyInfo>
  228. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  229. </AssemblyInfo>
  230. <ReturnValue>
  231. <ReturnType>System.Boolean</ReturnType>
  232. </ReturnValue>
  233. <Docs>
  234. <summary>
  235. Return whether is executing engine console commands as OS-specific system command.
  236. Or
  237. Set whether to execute engine console commands as OS-specific system command.
  238. </summary>
  239. <value>To be added.</value>
  240. <remarks>To be added.</remarks>
  241. </Docs>
  242. </Member>
  243. <Member MemberName="FileExists">
  244. <MemberSignature Language="C#" Value="public bool FileExists (string fileName);" />
  245. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool FileExists(string fileName) cil managed" />
  246. <MemberType>Method</MemberType>
  247. <AssemblyInfo>
  248. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  249. </AssemblyInfo>
  250. <ReturnValue>
  251. <ReturnType>System.Boolean</ReturnType>
  252. </ReturnValue>
  253. <Parameters>
  254. <Parameter Name="fileName" Type="System.String" />
  255. </Parameters>
  256. <Docs>
  257. <param name="fileName">To be added.</param>
  258. <summary>
  259. Check if a file exists.
  260. </summary>
  261. <returns>To be added.</returns>
  262. <remarks>To be added.</remarks>
  263. </Docs>
  264. </Member>
  265. <Member MemberName="GetAppPreferencesDir">
  266. <MemberSignature Language="C#" Value="public string GetAppPreferencesDir (string org, string app);" />
  267. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetAppPreferencesDir(string org, string app) cil managed" />
  268. <MemberType>Method</MemberType>
  269. <AssemblyInfo>
  270. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  271. </AssemblyInfo>
  272. <ReturnValue>
  273. <ReturnType>System.String</ReturnType>
  274. </ReturnValue>
  275. <Parameters>
  276. <Parameter Name="org" Type="System.String" />
  277. <Parameter Name="app" Type="System.String" />
  278. </Parameters>
  279. <Docs>
  280. <param name="org">To be added.</param>
  281. <param name="app">To be added.</param>
  282. <summary>
  283. Return the application preferences directory.
  284. </summary>
  285. <returns>To be added.</returns>
  286. <remarks>To be added.</remarks>
  287. </Docs>
  288. </Member>
  289. <Member MemberName="GetLastModifiedTime">
  290. <MemberSignature Language="C#" Value="public uint GetLastModifiedTime (string fileName);" />
  291. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int32 GetLastModifiedTime(string fileName) cil managed" />
  292. <MemberType>Method</MemberType>
  293. <AssemblyInfo>
  294. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  295. </AssemblyInfo>
  296. <ReturnValue>
  297. <ReturnType>System.UInt32</ReturnType>
  298. </ReturnValue>
  299. <Parameters>
  300. <Parameter Name="fileName" Type="System.String" />
  301. </Parameters>
  302. <Docs>
  303. <param name="fileName">To be added.</param>
  304. <summary>
  305. Returns the file's last modified time as seconds since 1.1.1970, or 0 if can not be accessed.
  306. </summary>
  307. <returns>To be added.</returns>
  308. <remarks>To be added.</remarks>
  309. </Docs>
  310. </Member>
  311. <Member MemberName="HasRegisteredPaths">
  312. <MemberSignature Language="C#" Value="public bool HasRegisteredPaths ();" />
  313. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasRegisteredPaths() cil managed" />
  314. <MemberType>Method</MemberType>
  315. <AssemblyInfo>
  316. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  317. </AssemblyInfo>
  318. <ReturnValue>
  319. <ReturnType>System.Boolean</ReturnType>
  320. </ReturnValue>
  321. <Parameters />
  322. <Docs>
  323. <summary>
  324. Return whether paths have been registered.
  325. </summary>
  326. <returns>To be added.</returns>
  327. <remarks>To be added.</remarks>
  328. </Docs>
  329. </Member>
  330. <Member MemberName="ProgramDir">
  331. <MemberSignature Language="C#" Value="public string ProgramDir { get; }" />
  332. <MemberSignature Language="ILAsm" Value=".property instance string ProgramDir" />
  333. <MemberType>Property</MemberType>
  334. <AssemblyInfo>
  335. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  336. </AssemblyInfo>
  337. <ReturnValue>
  338. <ReturnType>System.String</ReturnType>
  339. </ReturnValue>
  340. <Docs>
  341. <summary>
  342. Return the program's directory. If it does not contain the Urho3D default CoreData and Data directories, and the current working directory does, return the working directory instead.
  343. </summary>
  344. <value>To be added.</value>
  345. <remarks>To be added.</remarks>
  346. </Docs>
  347. </Member>
  348. <Member MemberName="RegisterPath">
  349. <MemberSignature Language="C#" Value="public void RegisterPath (string pathName);" />
  350. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RegisterPath(string pathName) cil managed" />
  351. <MemberType>Method</MemberType>
  352. <AssemblyInfo>
  353. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  354. </AssemblyInfo>
  355. <ReturnValue>
  356. <ReturnType>System.Void</ReturnType>
  357. </ReturnValue>
  358. <Parameters>
  359. <Parameter Name="pathName" Type="System.String" />
  360. </Parameters>
  361. <Docs>
  362. <param name="pathName">To be added.</param>
  363. <summary>
  364. Register a path as allowed to access. If no paths are registered, all are allowed. Registering allowed paths is considered securing the Urho3D execution environment: running programs and opening files externally through the system will fail afterward.
  365. </summary>
  366. <remarks>To be added.</remarks>
  367. </Docs>
  368. </Member>
  369. <Member MemberName="Rename">
  370. <MemberSignature Language="C#" Value="public bool Rename (string srcFileName, string destFileName);" />
  371. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Rename(string srcFileName, string destFileName) cil managed" />
  372. <MemberType>Method</MemberType>
  373. <AssemblyInfo>
  374. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  375. </AssemblyInfo>
  376. <ReturnValue>
  377. <ReturnType>System.Boolean</ReturnType>
  378. </ReturnValue>
  379. <Parameters>
  380. <Parameter Name="srcFileName" Type="System.String" />
  381. <Parameter Name="destFileName" Type="System.String" />
  382. </Parameters>
  383. <Docs>
  384. <param name="srcFileName">To be added.</param>
  385. <param name="destFileName">To be added.</param>
  386. <summary>
  387. Rename a file. Return true if successful.
  388. </summary>
  389. <returns>To be added.</returns>
  390. <remarks>To be added.</remarks>
  391. </Docs>
  392. </Member>
  393. <Member MemberName="SetCurrentDir">
  394. <MemberSignature Language="C#" Value="public bool SetCurrentDir (string pathName);" />
  395. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetCurrentDir(string pathName) cil managed" />
  396. <MemberType>Method</MemberType>
  397. <AssemblyInfo>
  398. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  399. </AssemblyInfo>
  400. <ReturnValue>
  401. <ReturnType>System.Boolean</ReturnType>
  402. </ReturnValue>
  403. <Parameters>
  404. <Parameter Name="pathName" Type="System.String" />
  405. </Parameters>
  406. <Docs>
  407. <param name="pathName">To be added.</param>
  408. <summary>
  409. Set the current working directory.
  410. </summary>
  411. <returns>To be added.</returns>
  412. <remarks>To be added.</remarks>
  413. </Docs>
  414. </Member>
  415. <Member MemberName="SetLastModifiedTime">
  416. <MemberSignature Language="C#" Value="public bool SetLastModifiedTime (string fileName, uint newTime);" />
  417. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetLastModifiedTime(string fileName, unsigned int32 newTime) cil managed" />
  418. <MemberType>Method</MemberType>
  419. <AssemblyInfo>
  420. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  421. </AssemblyInfo>
  422. <ReturnValue>
  423. <ReturnType>System.Boolean</ReturnType>
  424. </ReturnValue>
  425. <Parameters>
  426. <Parameter Name="fileName" Type="System.String" />
  427. <Parameter Name="newTime" Type="System.UInt32" />
  428. </Parameters>
  429. <Docs>
  430. <param name="fileName">To be added.</param>
  431. <param name="newTime">To be added.</param>
  432. <summary>
  433. Set a file's last modified time as seconds since 1.1.1970. Return true on success.
  434. </summary>
  435. <returns>To be added.</returns>
  436. <remarks>To be added.</remarks>
  437. </Docs>
  438. </Member>
  439. <Member MemberName="SystemCommand">
  440. <MemberSignature Language="C#" Value="public int SystemCommand (string commandLine, bool redirectStdOutToLog);" />
  441. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 SystemCommand(string commandLine, bool redirectStdOutToLog) cil managed" />
  442. <MemberType>Method</MemberType>
  443. <AssemblyInfo>
  444. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  445. </AssemblyInfo>
  446. <ReturnValue>
  447. <ReturnType>System.Int32</ReturnType>
  448. </ReturnValue>
  449. <Parameters>
  450. <Parameter Name="commandLine" Type="System.String" />
  451. <Parameter Name="redirectStdOutToLog" Type="System.Boolean" />
  452. </Parameters>
  453. <Docs>
  454. <param name="commandLine">To be added.</param>
  455. <param name="redirectStdOutToLog">To be added.</param>
  456. <summary>
  457. Run a program using the command interpreter, block until it exits and return the exit code. Will fail if any allowed paths are defined.
  458. </summary>
  459. <returns>To be added.</returns>
  460. <remarks>To be added.</remarks>
  461. </Docs>
  462. </Member>
  463. <Member MemberName="SystemCommandAsync">
  464. <MemberSignature Language="C#" Value="public uint SystemCommandAsync (string commandLine);" />
  465. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int32 SystemCommandAsync(string commandLine) cil managed" />
  466. <MemberType>Method</MemberType>
  467. <AssemblyInfo>
  468. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  469. </AssemblyInfo>
  470. <ReturnValue>
  471. <ReturnType>System.UInt32</ReturnType>
  472. </ReturnValue>
  473. <Parameters>
  474. <Parameter Name="commandLine" Type="System.String" />
  475. </Parameters>
  476. <Docs>
  477. <param name="commandLine">To be added.</param>
  478. <summary>
  479. Run a program using the command interpreter asynchronously. Return a request ID or M_MAX_UNSIGNED if failed. The exit code will be posted together with the request ID in an AsyncExecFinished event. Will fail if any allowed paths are defined.
  480. </summary>
  481. <returns>To be added.</returns>
  482. <remarks>To be added.</remarks>
  483. </Docs>
  484. </Member>
  485. <Member MemberName="SystemOpen">
  486. <MemberSignature Language="C#" Value="public bool SystemOpen (string fileName, string mode);" />
  487. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SystemOpen(string fileName, string mode) cil managed" />
  488. <MemberType>Method</MemberType>
  489. <AssemblyInfo>
  490. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  491. </AssemblyInfo>
  492. <ReturnValue>
  493. <ReturnType>System.Boolean</ReturnType>
  494. </ReturnValue>
  495. <Parameters>
  496. <Parameter Name="fileName" Type="System.String" />
  497. <Parameter Name="mode" Type="System.String" />
  498. </Parameters>
  499. <Docs>
  500. <param name="fileName">To be added.</param>
  501. <param name="mode">To be added.</param>
  502. <summary>
  503. Open a file in an external program, with mode such as "edit" optionally specified. Will fail if any allowed paths are defined.
  504. </summary>
  505. <returns>To be added.</returns>
  506. <remarks>To be added.</remarks>
  507. </Docs>
  508. </Member>
  509. <Member MemberName="Type">
  510. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  511. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  512. <MemberType>Property</MemberType>
  513. <AssemblyInfo>
  514. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  515. </AssemblyInfo>
  516. <ReturnValue>
  517. <ReturnType>Urho.StringHash</ReturnType>
  518. </ReturnValue>
  519. <Docs>
  520. <summary>Urho's type system type.</summary>
  521. <value>StringHash representing the type for this C# type.</value>
  522. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  523. </Docs>
  524. </Member>
  525. <Member MemberName="TypeName">
  526. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  527. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  528. <MemberType>Property</MemberType>
  529. <AssemblyInfo>
  530. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  531. </AssemblyInfo>
  532. <ReturnValue>
  533. <ReturnType>System.String</ReturnType>
  534. </ReturnValue>
  535. <Docs>
  536. <summary>Urho's low-level type name.</summary>
  537. <value>Stringified low-level type name.</value>
  538. <remarks></remarks>
  539. </Docs>
  540. </Member>
  541. <Member MemberName="TypeNameStatic">
  542. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  543. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  544. <MemberType>Property</MemberType>
  545. <AssemblyInfo>
  546. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  547. </AssemblyInfo>
  548. <ReturnValue>
  549. <ReturnType>System.String</ReturnType>
  550. </ReturnValue>
  551. <Docs>
  552. <summary>Urho's low-level type name, accessible as a static method.</summary>
  553. <value>Stringified low-level type name.</value>
  554. <remarks></remarks>
  555. </Docs>
  556. </Member>
  557. <Member MemberName="TypeStatic">
  558. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  559. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  560. <MemberType>Property</MemberType>
  561. <AssemblyInfo>
  562. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  563. </AssemblyInfo>
  564. <ReturnValue>
  565. <ReturnType>Urho.StringHash</ReturnType>
  566. </ReturnValue>
  567. <Docs>
  568. <summary>To be added.</summary>
  569. <value>To be added.</value>
  570. <remarks>To be added.</remarks>
  571. </Docs>
  572. </Member>
  573. <Member MemberName="UserDocumentsDir">
  574. <MemberSignature Language="C#" Value="public string UserDocumentsDir { get; }" />
  575. <MemberSignature Language="ILAsm" Value=".property instance string UserDocumentsDir" />
  576. <MemberType>Property</MemberType>
  577. <AssemblyInfo>
  578. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  579. </AssemblyInfo>
  580. <ReturnValue>
  581. <ReturnType>System.String</ReturnType>
  582. </ReturnValue>
  583. <Docs>
  584. <summary>
  585. Return the user documents directory.
  586. </summary>
  587. <value>To be added.</value>
  588. <remarks>To be added.</remarks>
  589. </Docs>
  590. </Member>
  591. </Members>
  592. </Type>