VirtualBox

Changeset 45566 in vbox


Ignore:
Timestamp:
Apr 16, 2013 11:41:04 AM (12 years ago)
Author:
vboxsync
Message:

VirtualBox.xidl: Documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/Main/idl/VirtualBox.xidl

    r45565 r45566  
    95789578    </const>
    95799579    <const name="Broken"                value="1">
    9580       <desc>TODO</desc>
     9580      <desc>Input pipe is broken.</desc>
    95819581    </const>
    95829582    <const name="Available"             value="10">
    9583       <desc>TODO</desc>
     9583      <desc>Input pipe became available for writing.</desc>
    95849584    </const>
    95859585    <const name="Written"               value="50">
    9586       <desc>TODO</desc>
     9586      <desc>Data has been successfully written.</desc>
    95879587    </const>
    95889588    <const name="Overflow"              value="100">
    9589       <desc>TODO</desc>
     9589      <desc>Too much input data supplied, data overflow.</desc>
    95909590    </const>
    95919591  </enum>
    … …  
    96039603    </const>
    96049604    <const name="Opening"               value="10">
    9605       <desc>TODO</desc>
     9605      <desc>Guest file is opening.</desc>
    96069606    </const>
    96079607    <const name="Open"                  value="100">
    9608       <desc>TODO</desc>
     9608      <desc>Guest file has been successfully opened.</desc>
    96099609    </const>
    96109610    <const name="Closing"               value="150">
    9611       <desc>TODO</desc>
     9611      <desc>Guest file closing.</desc>
    96129612    </const>
    96139613    <const name="Closed"                value="200">
    9614       <desc>TODO</desc>
     9614      <desc>Guest file has been closed.</desc>
    96159615    </const>
    96169616    <const name="Down"                  value="600">
    9617       <desc>TODO</desc>
     9617      <desc>Service/OS is stopping, guest file was closed.</desc>
    96189618    </const>
    96199619    <const name="Error"                 value="800">
    … …  
    97059705    >
    97069706    <desc>
    9707       TODO
     9707      The IGuestErrorInfo interface represents extended error information which
     9708      happened while performing an operation on the guest.
    97089709    </desc>
    97099710
    97109711    <attribute name="result" type="long" readonly="yes">
    9711       <desc>TODO</desc>
     9712      <desc>Runtime (IPRT) error code. See include/iprt/err.h and include/VBox/err.h
     9713        for details.</desc>
    97129714    </attribute>
    97139715
    97149716    <attribute name="text" type="wstring" readonly="yes">
    9715       <desc>TODO</desc>
     9717      <desc>Text description of the error.</desc>
    97169718    </attribute>
    97179719
    … …  
    1086510867    <attribute name="status" type="FileStatus" readonly="yes">
    1086610868      <desc>
    10867         TODO
     10869        Current file status.
    1086810870      </desc>
    1086910871    </attribute>
    … …  
    1899919001    <const name="OnGuestSessionStateChanged" value="80">
    1900019002      <desc>
    19001         TODO
     19003        See <link to="IGuestSessionStateChangedEvent">IGuestSessionStateChangedEvent</link>.
    1900219004      </desc>
    1900319005    </const>
    1900419006    <const name="OnGuestSessionRegistered" value="81">
    1900519007      <desc>
    19006         TODO
     19008        See <link to="IGuestSessionRegisteredEvent">IGuestSessionRegisteredEvent</link>.
    1900719009      </desc>
    1900819010    </const>
    1900919011    <const name="OnGuestProcessRegistered" value="82">
    1901019012      <desc>
    19011         TODO
     19013        See <link to="IGuestProcessRegisteredEvent">IGuestProcessRegisteredEvent</link>.
    1901219014      </desc>
    1901319015    </const>
    1901419016    <const name="OnGuestProcessStateChanged" value="83">
    1901519017      <desc>
    19016         TODO
     19018        See <link to="IGuestProcessStateChangedEvent">IGuestProcessStateChangedEvent</link>.
    1901719019      </desc>
    1901819020    </const>
    1901919021    <const name="OnGuestProcessInputNotify" value="84">
    1902019022      <desc>
    19021         TODO
     19023        See <link to="IGuestProcessInputNotifyEvent">IGuestProcessInputNotifyEvent</link>.
    1902219024      </desc>
    1902319025    </const>
    1902419026    <const name="OnGuestProcessOutput" value="85">
    1902519027      <desc>
    19026         TODO
     19028        See <link to="IGuestProcessOutputEvent">IGuestProcessOutputEvent</link>.
    1902719029      </desc>
    1902819030    </const>
    1902919031    <const name="OnGuestFileRegistered" value="86">
    1903019032      <desc>
    19031         TODO
     19033        See <link to="IGuestFileRegisteredEvent">IGuestFileRegisteredEvent</link>.
    1903219034      </desc>
    1903319035    </const>
    1903419036    <const name="OnGuestFileStateChanged" value="87">
    1903519037      <desc>
    19036         TODO
     19038        See <link to="IGuestFileStateChangedEvent">IGuestFileStateChangedEvent</link>.
    1903719039      </desc>
    1903819040    </const>
    1903919041    <const name="OnGuestFileOffsetChanged" value="88">
    1904019042      <desc>
    19041         TODO
     19043        See <link to="IGuestFileOffsetChangedEvent">IGuestFileOffsetChangedEvent</link>.
    1904219044      </desc>
    1904319045    </const>
    1904419046    <const name="OnGuestFileRead" value="89">
    1904519047      <desc>
    19046         For performance reasons ... TODO
     19048        See <link to="IGuestFileReadEvent">IGuestFileReadEvent</link>.
     19049       
     19050        <note internal="yes">For performance reasons this is a separate event to
     19051          not unnecessarily overflow the event queue.</note>         
    1904719052      </desc>
    1904819053    </const>
    1904919054    <const name="OnGuestFileWrite" value="90">
    1905019055      <desc>
    19051         For performance reasons ... TODO
     19056        See <link to="IGuestFileWriteEvent">IGuestFileWriteEvent</link>.
     19057     
     19058        <note internal="yes">For performance reasons this is a separate event to
     19059          not unnecessarily overflow the event queue.</note>         
    1905219060      </desc>
    1905319061    </const>
    … …  
    1994419952    >
    1994519953    <desc>
    19946       TODO
     19954      Notification when a guest session changed its state.
    1994719955    </desc>
    1994819956
    1994919957    <attribute name="id" type="unsigned long" readonly="yes">
    1995019958      <desc>
    19951         TODO
     19959        Session ID of guest session which was changed.
    1995219960      </desc>
    1995319961    </attribute>
    1995419962    <attribute name="status" type="GuestSessionStatus" readonly="yes">
    1995519963      <desc>
    19956         TODO
     19964        New session status.
    1995719965      </desc>
    1995819966    </attribute>
    1995919967    <attribute name="error" type="IGuestErrorInfo" readonly="yes">
    1996019968      <desc>
    19961         TODO
     19969        Extended guest error information in case of new session
     19970        status is indicating an error.
    1996219971      </desc>
    1996319972    </attribute>
    … …  
    1997119980    >
    1997219981    <desc>
    19973       TODO
     19982      Notification when a guest session was registered or unregistered.
    1997419983    </desc>
    1997519984
    1997619985    <attribute name="registered" type="boolean" readonly="yes">
    1997719986      <desc>
    19978         TODO
     19987        If @c true, the guest session was registered, otherwise it was
     19988        unregistered.
    1997919989      </desc>
    1998019990    </attribute>
    … …  
    1999120001    <attribute name="process" type="IGuestProcess" readonly="yes">
    1999220002      <desc>
    19993         TODO
     20003        Guest process object which is related to this event.
    1999420004      </desc>
    1999520005    </attribute>
    1999620006    <attribute name="pid" type="unsigned long" readonly="yes">
    1999720007      <desc>
    19998         TODO
     20008        Guest process ID (PID).
    1999920009      </desc>
    2000020010    </attribute>
    … …  
    2000820018    >
    2000920019    <desc>
    20010       TODO
     20020      Notification when a guest process was registered or unregistered.
    2001120021    </desc>
    2001220022
    2001320023    <attribute name="registered" type="boolean" readonly="yes">
    2001420024      <desc>
    20015         TODO
     20025        If @c true, the guest process was registered, otherwise it was
     20026        unregistered.
    2001620027      </desc>
    2001720028    </attribute>
    … …  
    2002520036    >
    2002620037    <desc>
    20027       TODO
     20038      Notification when a guest process changed its state.
    2002820039    </desc>
    2002920040
    2003020041    <attribute name="status" type="ProcessStatus" readonly="yes">
    2003120042      <desc>
    20032         TODO
     20043        New guest process status.
    2003320044      </desc>
    2003420045    </attribute>
    2003520046    <attribute name="error" type="IGuestErrorInfo" readonly="yes">
    2003620047      <desc>
    20037         TODO
     20048        Extended guest error information in case of new process
     20049        status is indicating an error.
    2003820050      </desc>
    2003920051    </attribute>
    … …  
    2005220064    <attribute name="handle" type="unsigned long" readonly="yes">
    2005320065      <desc>
    20054         TODO
     20066        Input/output (IO) handle involved in this event. Usually 0 is stdin,
     20067        1 is stdout and 2 is stderr.
    2005520068      </desc>
    2005620069    </attribute>
    … …  
    2005820071    <attribute name="processed" type="unsigned long" readonly="yes">
    2005920072      <desc>
    20060         TODO
     20073        Processed input or output (in bytes).
    2006120074      </desc>
    2006220075    </attribute>
    … …  
    2007020083    >
    2007120084    <desc>
    20072       TODO
     20085      Notification when a guest process' stdin became available.
     20086      <note>This event is right now not implemented!</note>
    2007320087    </desc>
    2007420088
    2007520089    <attribute name="status" type="ProcessInputStatus" readonly="yes">
    2007620090      <desc>
    20077         TODO
     20091        Current process input status.
    2007820092      </desc>
    2007920093    </attribute>
    … …  
    2008720101    >
    2008820102    <desc>
    20089       TODO
     20103      Notification when there is guest process output available for reading.
    2009020104    </desc>
    2009120105
    2009220106    <attribute name="data" type="octet" safearray="yes" readonly="yes">
    2009320107      <desc>
    20094         TODO
     20108        Actual output data.
    2009520109      </desc>
    2009620110    </attribute>
    … …  
    2010720121    <attribute name="file" type="IGuestFile" readonly="yes">
    2010820122      <desc>
    20109         TODO
     20123        Guest file object which is related to this event.
    2011020124      </desc>
    2011120125    </attribute>
    … …  
    2011920133    >
    2012020134    <desc>
    20121       TODO
     20135      Notification when a guest file was registered or unregistered.
    2012220136    </desc>
    2012320137
    2012420138    <attribute name="registered" type="boolean" readonly="yes">
    2012520139      <desc>
    20126         TODO
     20140        If @c true, the guest file was registered, otherwise it was
     20141        unregistered.
    2012720142      </desc>
    2012820143    </attribute>
    … …  
    2013620151    >
    2013720152    <desc>
    20138       TODO
     20153      Notification when a guest file changed its state.
    2013920154    </desc>
    2014020155
    2014120156    <attribute name="status" type="FileStatus" readonly="yes">
    2014220157      <desc>
    20143         TODO
     20158        New guest file status.
    2014420159      </desc>
    2014520160    </attribute>
    2014620161    <attribute name="error" type="IGuestErrorInfo" readonly="yes">
    2014720162      <desc>
    20148         TODO
     20163        Extended guest error information in case of new file
     20164        status is indicating an error.
    2014920165      </desc>
    2015020166    </attribute>
    … …  
    2016620182    <attribute name="offset" type="long long" readonly="yes">
    2016720183      <desc>
    20168         TODO
     20184        Current offset (in bytes).
    2016920185      </desc>
    2017020186    </attribute>
    2017120187    <attribute name="processed" type="unsigned long" readonly="yes">
    2017220188      <desc>
    20173         TODO
    20174       </desc>
    20175 
     20189        Processed input or output (in bytes).
     20190      </desc>
    2017620191    </attribute>
    2017720192
    … …  
    2018420199    >
    2018520200    <desc>
    20186       TODO
     20201      Notification when a guest file changed its current offset.
    2018720202    </desc>
    2018820203
    … …  
    2019520210    >
    2019620211    <desc>
    20197       TODO
     20212      Notification when data has been read from a guest file.
    2019820213    </desc>
    2019920214
    2020020215    <attribute name="data" type="octet" safearray="yes" readonly="yes">
    2020120216      <desc>
    20202         TODO
     20217        Actual data read.
    2020320218      </desc>
    2020420219    </attribute>
    … …  
    2021220227    >
    2021320228    <desc>
    20214       TODO
     20229      Notification when data has been written to a guest file.
    2021520230    </desc>
    2021620231
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette