2
0

FileSystem.xml 27 KB

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