FileSystem.xml 28 KB

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