FileSystem.xml 27 KB

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