FileSystem.xml 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683
  1. <Type Name="FileSystem" FullName="Urho.IO.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 ();" />
  21. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  22. <MemberType>Constructor</MemberType>
  23. <AssemblyInfo>
  24. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  25. </AssemblyInfo>
  26. <Attributes>
  27. <Attribute>
  28. <AttributeName>Preserve</AttributeName>
  29. </Attribute>
  30. </Attributes>
  31. <Parameters />
  32. <Docs>
  33. <summary>
  34. <para>Constructs a new instance of Urho.IO.FileSystem which is tied to the <see cref="P:Urho.Application.CurrentContext" />.</para>
  35. </summary>
  36. <remarks>
  37. </remarks>
  38. </Docs>
  39. </Member>
  40. <Member MemberName=".ctor">
  41. <MemberSignature Language="C#" Value="public FileSystem (IntPtr handle);" />
  42. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  43. <MemberType>Constructor</MemberType>
  44. <AssemblyInfo>
  45. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  46. </AssemblyInfo>
  47. <Attributes>
  48. <Attribute>
  49. <AttributeName>Preserve</AttributeName>
  50. </Attribute>
  51. </Attributes>
  52. <Parameters>
  53. <Parameter Name="handle" Type="System.IntPtr" />
  54. </Parameters>
  55. <Docs>
  56. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  57. <summary>Constructs a new instance of Urho.IO.FileSystem, given a raw pointer to an unmanaged object</summary>
  58. <remarks>
  59. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  60. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  61. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  62. </remarks>
  63. </Docs>
  64. </Member>
  65. <Member MemberName=".ctor">
  66. <MemberSignature Language="C#" Value="public FileSystem (Urho.Context context);" />
  67. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  68. <MemberType>Constructor</MemberType>
  69. <AssemblyInfo>
  70. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  71. </AssemblyInfo>
  72. <Attributes>
  73. <Attribute>
  74. <AttributeName>Preserve</AttributeName>
  75. </Attribute>
  76. </Attributes>
  77. <Parameters>
  78. <Parameter Name="context" Type="Urho.Context" />
  79. </Parameters>
  80. <Docs>
  81. <param name="context">The context that this object will be attached to.</param>
  82. <summary>
  83. <para>Constructs a new instance of Urho.IO.FileSystem linked to a specific <see cref="T:Urho.Context" />.</para>
  84. </summary>
  85. <remarks>
  86. </remarks>
  87. </Docs>
  88. </Member>
  89. <Member MemberName=".ctor">
  90. <MemberSignature Language="C#" Value="protected FileSystem (Urho.UrhoObjectFlag emptyFlag);" />
  91. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  92. <MemberType>Constructor</MemberType>
  93. <AssemblyInfo>
  94. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  95. </AssemblyInfo>
  96. <Attributes>
  97. <Attribute>
  98. <AttributeName>Preserve</AttributeName>
  99. </Attribute>
  100. </Attributes>
  101. <Parameters>
  102. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  103. </Parameters>
  104. <Docs>
  105. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  106. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  107. <remarks>
  108. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  109. <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>
  110. <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>
  111. </remarks>
  112. </Docs>
  113. </Member>
  114. <Member MemberName="AsyncExecFinished">
  115. <MemberSignature Language="C#" Value="public event Action&lt;Urho.IO.AsyncExecFinishedEventArgs&gt; AsyncExecFinished;" />
  116. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.IO.AsyncExecFinishedEventArgs&gt; AsyncExecFinished" />
  117. <MemberType>Event</MemberType>
  118. <AssemblyInfo>
  119. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  120. </AssemblyInfo>
  121. <ReturnValue>
  122. <ReturnType>System.Action&lt;Urho.IO.AsyncExecFinishedEventArgs&gt;</ReturnType>
  123. </ReturnValue>
  124. <Docs>
  125. <summary>To be added.</summary>
  126. <remarks>
  127. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToAsyncExecFinished" /> method. That one will force that callback and will ignore any previously set events here.</para>
  128. </remarks>
  129. </Docs>
  130. </Member>
  131. <Member MemberName="CheckAccess">
  132. <MemberSignature Language="C#" Value="public bool CheckAccess (string pathName);" />
  133. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool CheckAccess(string pathName) cil managed" />
  134. <MemberType>Method</MemberType>
  135. <AssemblyInfo>
  136. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  137. </AssemblyInfo>
  138. <ReturnValue>
  139. <ReturnType>System.Boolean</ReturnType>
  140. </ReturnValue>
  141. <Parameters>
  142. <Parameter Name="pathName" Type="System.String" />
  143. </Parameters>
  144. <Docs>
  145. <param name="pathName">To be added.</param>
  146. <summary>
  147. Check if a path is allowed to be accessed. If no paths are registered, all are allowed.
  148. </summary>
  149. <returns>To be added.</returns>
  150. <remarks>To be added.</remarks>
  151. </Docs>
  152. </Member>
  153. <Member MemberName="Copy">
  154. <MemberSignature Language="C#" Value="public bool Copy (string srcFileName, string destFileName);" />
  155. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Copy(string srcFileName, string destFileName) cil managed" />
  156. <MemberType>Method</MemberType>
  157. <AssemblyInfo>
  158. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  159. </AssemblyInfo>
  160. <ReturnValue>
  161. <ReturnType>System.Boolean</ReturnType>
  162. </ReturnValue>
  163. <Parameters>
  164. <Parameter Name="srcFileName" Type="System.String" />
  165. <Parameter Name="destFileName" Type="System.String" />
  166. </Parameters>
  167. <Docs>
  168. <param name="srcFileName">To be added.</param>
  169. <param name="destFileName">To be added.</param>
  170. <summary>
  171. Copy a file. Return true if successful.
  172. </summary>
  173. <returns>To be added.</returns>
  174. <remarks>To be added.</remarks>
  175. </Docs>
  176. </Member>
  177. <Member MemberName="CreateDir">
  178. <MemberSignature Language="C#" Value="public bool CreateDir (string pathName);" />
  179. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool CreateDir(string pathName) cil managed" />
  180. <MemberType>Method</MemberType>
  181. <AssemblyInfo>
  182. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  183. </AssemblyInfo>
  184. <ReturnValue>
  185. <ReturnType>System.Boolean</ReturnType>
  186. </ReturnValue>
  187. <Parameters>
  188. <Parameter Name="pathName" Type="System.String" />
  189. </Parameters>
  190. <Docs>
  191. <param name="pathName">To be added.</param>
  192. <summary>
  193. Create a directory.
  194. </summary>
  195. <returns>To be added.</returns>
  196. <remarks>To be added.</remarks>
  197. </Docs>
  198. </Member>
  199. <Member MemberName="CurrentDir">
  200. <MemberSignature Language="C#" Value="public string CurrentDir { get; }" />
  201. <MemberSignature Language="ILAsm" Value=".property instance string CurrentDir" />
  202. <MemberType>Property</MemberType>
  203. <AssemblyInfo>
  204. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  205. </AssemblyInfo>
  206. <ReturnValue>
  207. <ReturnType>System.String</ReturnType>
  208. </ReturnValue>
  209. <Docs>
  210. <summary>
  211. Return the absolute current working directory.
  212. </summary>
  213. <value>To be added.</value>
  214. <remarks>To be added.</remarks>
  215. </Docs>
  216. </Member>
  217. <Member MemberName="Delete">
  218. <MemberSignature Language="C#" Value="public bool Delete (string fileName);" />
  219. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Delete(string fileName) cil managed" />
  220. <MemberType>Method</MemberType>
  221. <AssemblyInfo>
  222. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  223. </AssemblyInfo>
  224. <ReturnValue>
  225. <ReturnType>System.Boolean</ReturnType>
  226. </ReturnValue>
  227. <Parameters>
  228. <Parameter Name="fileName" Type="System.String" />
  229. </Parameters>
  230. <Docs>
  231. <param name="fileName">To be added.</param>
  232. <summary>
  233. Delete a file. Return true if successful.
  234. </summary>
  235. <returns>To be added.</returns>
  236. <remarks>To be added.</remarks>
  237. </Docs>
  238. </Member>
  239. <Member MemberName="DirExists">
  240. <MemberSignature Language="C#" Value="public bool DirExists (string pathName);" />
  241. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool DirExists(string pathName) cil managed" />
  242. <MemberType>Method</MemberType>
  243. <AssemblyInfo>
  244. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  245. </AssemblyInfo>
  246. <ReturnValue>
  247. <ReturnType>System.Boolean</ReturnType>
  248. </ReturnValue>
  249. <Parameters>
  250. <Parameter Name="pathName" Type="System.String" />
  251. </Parameters>
  252. <Docs>
  253. <param name="pathName">To be added.</param>
  254. <summary>
  255. Check if a directory exists.
  256. </summary>
  257. <returns>To be added.</returns>
  258. <remarks>To be added.</remarks>
  259. </Docs>
  260. </Member>
  261. <Member MemberName="ExecuteConsoleCommands">
  262. <MemberSignature Language="C#" Value="public bool ExecuteConsoleCommands { get; set; }" />
  263. <MemberSignature Language="ILAsm" Value=".property instance bool ExecuteConsoleCommands" />
  264. <MemberType>Property</MemberType>
  265. <AssemblyInfo>
  266. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  267. </AssemblyInfo>
  268. <ReturnValue>
  269. <ReturnType>System.Boolean</ReturnType>
  270. </ReturnValue>
  271. <Docs>
  272. <summary>
  273. Return whether is executing engine console commands as OS-specific system command.
  274. Or
  275. Set whether to execute engine console commands as OS-specific system command.
  276. </summary>
  277. <value>To be added.</value>
  278. <remarks>To be added.</remarks>
  279. </Docs>
  280. </Member>
  281. <Member MemberName="FileExists">
  282. <MemberSignature Language="C#" Value="public bool FileExists (string fileName);" />
  283. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool FileExists(string fileName) cil managed" />
  284. <MemberType>Method</MemberType>
  285. <AssemblyInfo>
  286. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  287. </AssemblyInfo>
  288. <ReturnValue>
  289. <ReturnType>System.Boolean</ReturnType>
  290. </ReturnValue>
  291. <Parameters>
  292. <Parameter Name="fileName" Type="System.String" />
  293. </Parameters>
  294. <Docs>
  295. <param name="fileName">To be added.</param>
  296. <summary>
  297. Check if a file exists.
  298. </summary>
  299. <returns>To be added.</returns>
  300. <remarks>To be added.</remarks>
  301. </Docs>
  302. </Member>
  303. <Member MemberName="GetAppPreferencesDir">
  304. <MemberSignature Language="C#" Value="public string GetAppPreferencesDir (string org, string app);" />
  305. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetAppPreferencesDir(string org, string app) cil managed" />
  306. <MemberType>Method</MemberType>
  307. <AssemblyInfo>
  308. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  309. </AssemblyInfo>
  310. <ReturnValue>
  311. <ReturnType>System.String</ReturnType>
  312. </ReturnValue>
  313. <Parameters>
  314. <Parameter Name="org" Type="System.String" />
  315. <Parameter Name="app" Type="System.String" />
  316. </Parameters>
  317. <Docs>
  318. <param name="org">To be added.</param>
  319. <param name="app">To be added.</param>
  320. <summary>
  321. Return the application preferences directory.
  322. </summary>
  323. <returns>To be added.</returns>
  324. <remarks>To be added.</remarks>
  325. </Docs>
  326. </Member>
  327. <Member MemberName="GetLastModifiedTime">
  328. <MemberSignature Language="C#" Value="public uint GetLastModifiedTime (string fileName);" />
  329. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int32 GetLastModifiedTime(string fileName) cil managed" />
  330. <MemberType>Method</MemberType>
  331. <AssemblyInfo>
  332. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  333. </AssemblyInfo>
  334. <ReturnValue>
  335. <ReturnType>System.UInt32</ReturnType>
  336. </ReturnValue>
  337. <Parameters>
  338. <Parameter Name="fileName" Type="System.String" />
  339. </Parameters>
  340. <Docs>
  341. <param name="fileName">To be added.</param>
  342. <summary>
  343. Returns the file's last modified time as seconds since 1.1.1970, or 0 if can not be accessed.
  344. </summary>
  345. <returns>To be added.</returns>
  346. <remarks>To be added.</remarks>
  347. </Docs>
  348. </Member>
  349. <Member MemberName="HasRegisteredPaths">
  350. <MemberSignature Language="C#" Value="public bool HasRegisteredPaths ();" />
  351. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasRegisteredPaths() cil managed" />
  352. <MemberType>Method</MemberType>
  353. <AssemblyInfo>
  354. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  355. </AssemblyInfo>
  356. <ReturnValue>
  357. <ReturnType>System.Boolean</ReturnType>
  358. </ReturnValue>
  359. <Parameters />
  360. <Docs>
  361. <summary>
  362. Return whether paths have been registered.
  363. </summary>
  364. <returns>To be added.</returns>
  365. <remarks>To be added.</remarks>
  366. </Docs>
  367. </Member>
  368. <Member MemberName="ProgramDir">
  369. <MemberSignature Language="C#" Value="public string ProgramDir { get; }" />
  370. <MemberSignature Language="ILAsm" Value=".property instance string ProgramDir" />
  371. <MemberType>Property</MemberType>
  372. <AssemblyInfo>
  373. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  374. </AssemblyInfo>
  375. <ReturnValue>
  376. <ReturnType>System.String</ReturnType>
  377. </ReturnValue>
  378. <Docs>
  379. <summary>
  380. 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.
  381. </summary>
  382. <value>To be added.</value>
  383. <remarks>To be added.</remarks>
  384. </Docs>
  385. </Member>
  386. <Member MemberName="RegisterPath">
  387. <MemberSignature Language="C#" Value="public void RegisterPath (string pathName);" />
  388. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RegisterPath(string pathName) cil managed" />
  389. <MemberType>Method</MemberType>
  390. <AssemblyInfo>
  391. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  392. </AssemblyInfo>
  393. <ReturnValue>
  394. <ReturnType>System.Void</ReturnType>
  395. </ReturnValue>
  396. <Parameters>
  397. <Parameter Name="pathName" Type="System.String" />
  398. </Parameters>
  399. <Docs>
  400. <param name="pathName">To be added.</param>
  401. <summary>
  402. 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.
  403. </summary>
  404. <remarks>To be added.</remarks>
  405. </Docs>
  406. </Member>
  407. <Member MemberName="Rename">
  408. <MemberSignature Language="C#" Value="public bool Rename (string srcFileName, string destFileName);" />
  409. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Rename(string srcFileName, string destFileName) cil managed" />
  410. <MemberType>Method</MemberType>
  411. <AssemblyInfo>
  412. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  413. </AssemblyInfo>
  414. <ReturnValue>
  415. <ReturnType>System.Boolean</ReturnType>
  416. </ReturnValue>
  417. <Parameters>
  418. <Parameter Name="srcFileName" Type="System.String" />
  419. <Parameter Name="destFileName" Type="System.String" />
  420. </Parameters>
  421. <Docs>
  422. <param name="srcFileName">To be added.</param>
  423. <param name="destFileName">To be added.</param>
  424. <summary>
  425. Rename a file. Return true if successful.
  426. </summary>
  427. <returns>To be added.</returns>
  428. <remarks>To be added.</remarks>
  429. </Docs>
  430. </Member>
  431. <Member MemberName="SetCurrentDir">
  432. <MemberSignature Language="C#" Value="public bool SetCurrentDir (string pathName);" />
  433. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetCurrentDir(string pathName) cil managed" />
  434. <MemberType>Method</MemberType>
  435. <AssemblyInfo>
  436. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  437. </AssemblyInfo>
  438. <ReturnValue>
  439. <ReturnType>System.Boolean</ReturnType>
  440. </ReturnValue>
  441. <Parameters>
  442. <Parameter Name="pathName" Type="System.String" />
  443. </Parameters>
  444. <Docs>
  445. <param name="pathName">To be added.</param>
  446. <summary>
  447. Set the current working directory.
  448. </summary>
  449. <returns>To be added.</returns>
  450. <remarks>To be added.</remarks>
  451. </Docs>
  452. </Member>
  453. <Member MemberName="SetLastModifiedTime">
  454. <MemberSignature Language="C#" Value="public bool SetLastModifiedTime (string fileName, uint newTime);" />
  455. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetLastModifiedTime(string fileName, unsigned int32 newTime) cil managed" />
  456. <MemberType>Method</MemberType>
  457. <AssemblyInfo>
  458. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  459. </AssemblyInfo>
  460. <ReturnValue>
  461. <ReturnType>System.Boolean</ReturnType>
  462. </ReturnValue>
  463. <Parameters>
  464. <Parameter Name="fileName" Type="System.String" />
  465. <Parameter Name="newTime" Type="System.UInt32" />
  466. </Parameters>
  467. <Docs>
  468. <param name="fileName">To be added.</param>
  469. <param name="newTime">To be added.</param>
  470. <summary>
  471. Set a file's last modified time as seconds since 1.1.1970. Return true on success.
  472. </summary>
  473. <returns>To be added.</returns>
  474. <remarks>To be added.</remarks>
  475. </Docs>
  476. </Member>
  477. <Member MemberName="SubscribeToAsyncExecFinished">
  478. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToAsyncExecFinished (Action&lt;Urho.IO.AsyncExecFinishedEventArgs&gt; handler);" />
  479. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToAsyncExecFinished(class System.Action`1&lt;valuetype Urho.IO.AsyncExecFinishedEventArgs&gt; handler) cil managed" />
  480. <MemberType>Method</MemberType>
  481. <AssemblyInfo>
  482. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  483. </AssemblyInfo>
  484. <Attributes>
  485. <Attribute>
  486. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.AsyncExecFinished += ...' instead.")</AttributeName>
  487. </Attribute>
  488. </Attributes>
  489. <ReturnValue>
  490. <ReturnType>Urho.Subscription</ReturnType>
  491. </ReturnValue>
  492. <Parameters>
  493. <Parameter Name="handler" Type="System.Action&lt;Urho.IO.AsyncExecFinishedEventArgs&gt;" />
  494. </Parameters>
  495. <Docs>
  496. <param name="handler">The handler to invoke when this event is raised.</param>
  497. <summary>Subscribes to the AsyncExecFinished event raised by the FileSystem.</summary>
  498. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  499. <remarks>
  500. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  501. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  502. <para>For a more event-like approach, use the <see cref="E:Urho.IO.FileSystem.AsyncExecFinished" /> event.</para>
  503. </remarks>
  504. </Docs>
  505. </Member>
  506. <Member MemberName="SystemCommand">
  507. <MemberSignature Language="C#" Value="public int SystemCommand (string commandLine, bool redirectStdOutToLog = false);" />
  508. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 SystemCommand(string commandLine, bool redirectStdOutToLog) cil managed" />
  509. <MemberType>Method</MemberType>
  510. <AssemblyInfo>
  511. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  512. </AssemblyInfo>
  513. <ReturnValue>
  514. <ReturnType>System.Int32</ReturnType>
  515. </ReturnValue>
  516. <Parameters>
  517. <Parameter Name="commandLine" Type="System.String" />
  518. <Parameter Name="redirectStdOutToLog" Type="System.Boolean" />
  519. </Parameters>
  520. <Docs>
  521. <param name="commandLine">To be added.</param>
  522. <param name="redirectStdOutToLog">To be added.</param>
  523. <summary>
  524. Run a program using the command interpreter, block until it exits and return the exit code. Will fail if any allowed paths are defined.
  525. </summary>
  526. <returns>To be added.</returns>
  527. <remarks>To be added.</remarks>
  528. </Docs>
  529. </Member>
  530. <Member MemberName="SystemCommandAsync">
  531. <MemberSignature Language="C#" Value="public uint SystemCommandAsync (string commandLine);" />
  532. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int32 SystemCommandAsync(string commandLine) cil managed" />
  533. <MemberType>Method</MemberType>
  534. <AssemblyInfo>
  535. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  536. </AssemblyInfo>
  537. <ReturnValue>
  538. <ReturnType>System.UInt32</ReturnType>
  539. </ReturnValue>
  540. <Parameters>
  541. <Parameter Name="commandLine" Type="System.String" />
  542. </Parameters>
  543. <Docs>
  544. <param name="commandLine">To be added.</param>
  545. <summary>
  546. 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.
  547. </summary>
  548. <returns>To be added.</returns>
  549. <remarks>To be added.</remarks>
  550. </Docs>
  551. </Member>
  552. <Member MemberName="SystemOpen">
  553. <MemberSignature Language="C#" Value="public bool SystemOpen (string fileName, string mode = &quot;&quot;);" />
  554. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SystemOpen(string fileName, string mode) cil managed" />
  555. <MemberType>Method</MemberType>
  556. <AssemblyInfo>
  557. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  558. </AssemblyInfo>
  559. <ReturnValue>
  560. <ReturnType>System.Boolean</ReturnType>
  561. </ReturnValue>
  562. <Parameters>
  563. <Parameter Name="fileName" Type="System.String" />
  564. <Parameter Name="mode" Type="System.String" />
  565. </Parameters>
  566. <Docs>
  567. <param name="fileName">To be added.</param>
  568. <param name="mode">To be added.</param>
  569. <summary>
  570. Open a file in an external program, with mode such as "edit" optionally specified. Will fail if any allowed paths are defined.
  571. </summary>
  572. <returns>To be added.</returns>
  573. <remarks>To be added.</remarks>
  574. </Docs>
  575. </Member>
  576. <Member MemberName="TemporaryDir">
  577. <MemberSignature Language="C#" Value="public string TemporaryDir { get; }" />
  578. <MemberSignature Language="ILAsm" Value=".property instance string TemporaryDir" />
  579. <MemberType>Property</MemberType>
  580. <AssemblyInfo>
  581. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  582. </AssemblyInfo>
  583. <ReturnValue>
  584. <ReturnType>System.String</ReturnType>
  585. </ReturnValue>
  586. <Docs>
  587. <summary>Return path of temporary directory. Path always ends with a forward slash.</summary>
  588. <value>To be added.</value>
  589. <remarks>To be added.</remarks>
  590. </Docs>
  591. </Member>
  592. <Member MemberName="Type">
  593. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  594. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  595. <MemberType>Property</MemberType>
  596. <AssemblyInfo>
  597. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  598. </AssemblyInfo>
  599. <ReturnValue>
  600. <ReturnType>Urho.StringHash</ReturnType>
  601. </ReturnValue>
  602. <Docs>
  603. <summary>Urho's type system type.</summary>
  604. <value>StringHash representing the type for this C# type.</value>
  605. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  606. </Docs>
  607. </Member>
  608. <Member MemberName="TypeName">
  609. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  610. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  611. <MemberType>Property</MemberType>
  612. <AssemblyInfo>
  613. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  614. </AssemblyInfo>
  615. <ReturnValue>
  616. <ReturnType>System.String</ReturnType>
  617. </ReturnValue>
  618. <Docs>
  619. <summary>Urho's low-level type name.</summary>
  620. <value>Stringified low-level type name.</value>
  621. <remarks>
  622. </remarks>
  623. </Docs>
  624. </Member>
  625. <Member MemberName="TypeNameStatic">
  626. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  627. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  628. <MemberType>Property</MemberType>
  629. <AssemblyInfo>
  630. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  631. </AssemblyInfo>
  632. <ReturnValue>
  633. <ReturnType>System.String</ReturnType>
  634. </ReturnValue>
  635. <Docs>
  636. <summary>Urho's low-level type name, accessible as a static method.</summary>
  637. <value>Stringified low-level type name.</value>
  638. <remarks>
  639. </remarks>
  640. </Docs>
  641. </Member>
  642. <Member MemberName="TypeStatic">
  643. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  644. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  645. <MemberType>Property</MemberType>
  646. <AssemblyInfo>
  647. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  648. </AssemblyInfo>
  649. <Attributes>
  650. <Attribute>
  651. <AttributeName>Preserve</AttributeName>
  652. </Attribute>
  653. </Attributes>
  654. <ReturnValue>
  655. <ReturnType>Urho.StringHash</ReturnType>
  656. </ReturnValue>
  657. <Docs>
  658. <summary>Urho's low-level type, accessible as a static method.</summary>
  659. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  660. <remarks>
  661. </remarks>
  662. </Docs>
  663. </Member>
  664. <Member MemberName="UserDocumentsDir">
  665. <MemberSignature Language="C#" Value="public string UserDocumentsDir { get; }" />
  666. <MemberSignature Language="ILAsm" Value=".property instance string UserDocumentsDir" />
  667. <MemberType>Property</MemberType>
  668. <AssemblyInfo>
  669. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  670. </AssemblyInfo>
  671. <ReturnValue>
  672. <ReturnType>System.String</ReturnType>
  673. </ReturnValue>
  674. <Docs>
  675. <summary>
  676. Return the user documents directory.
  677. </summary>
  678. <value>To be added.</value>
  679. <remarks>To be added.</remarks>
  680. </Docs>
  681. </Member>
  682. </Members>
  683. </Type>