110401(DTXMania089)/SlimDXc_Jun2010(VC++2008)/source/directsound/ResultCodeDS.h

   1 /*\r
   2 * Copyright (c) 2007-2010 SlimDX Group\r
   3 * \r
   4 * Permission is hereby granted, free of charge, to any person obtaining a copy\r
   5 * of this software and associated documentation files (the "Software"), to deal\r
   6 * in the Software without restriction, including without limitation the rights\r
   7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r
   8 * copies of the Software, and to permit persons to whom the Software is\r
   9 * furnished to do so, subject to the following conditions:\r
  10 * \r
  11 * The above copyright notice and this permission notice shall be included in\r
  12 * all copies or substantial portions of the Software.\r
  13 * \r
  14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
  16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
  17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
  18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
  19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\r
  20 * THE SOFTWARE.\r
  21 */\r
  22 #pragma once\r
  23 \r
  24 #ifdef XMLDOCS\r
  25 #include "Enums.h"\r
  26 #endif\r
  27 \r
  28 namespace SlimDX\r
  29 {\r
  30         namespace DirectSound\r
  31         {\r
  32                 /// <summary>Defines result codes that are returned by DirectSound 8 functions.</summary>\r
  33                 /// <unmanaged href="bb219706">HRESULT</unmanaged>\r
  34                 public ref class ResultCode sealed\r
  35                 {\r
  36                 private:\r
  37                         ResultCode();\r
  38 \r
  39                 public:\r
  40                         /// <summary>\r
  41                         /// The function completed successfully.\r
  42                         /// </summary>\r
  43                         /// <remarks>This is a successful result.</remarks>\r
  44                         /// <unmanaged href="bb219706">DS_OK</unmanaged>\r
  45                         property static Result Success\r
  46                         {\r
  47                                 Result get();\r
  48                         }\r
  49 \r
  50                         /// <summary>\r
  51                         /// Represents a generic failure result.\r
  52                         /// </summary>\r
  53                         /// <remarks>This is a failed result.</remarks>\r
  54                         /// <unmanaged href="bb219706">E_FAIL</unmanaged>\r
  55                         property static Result Failure\r
  56                         {\r
  57                                 Result get();\r
  58                         }\r
  59 \r
  60                         /// <summary>\r
  61                         /// The 3D algorithm was substituted.\r
  62                         /// </summary>\r
  63                         /// <remarks>This is a successful result.</remarks>\r
  64                         /// <unmanaged href="bb219706">DS_NO_VIRTUALIZATION</unmanaged>\r
  65                         property static Result NoVirtualization\r
  66                         {\r
  67                                 Result get();\r
  68                         }\r
  69 \r
  70                         /// <summary>\r
  71                         /// Access is denied.\r
  72                         /// </summary>\r
  73                         /// <remarks>This is a failed result.</remarks>\r
  74                         /// <unmanaged href="bb219706">DSERR_ACCESSDENIED</unmanaged>\r
  75                         property static Result AccessDenied\r
  76                         {\r
  77                                 Result get();\r
  78                         }\r
  79 \r
  80                         /// <summary>\r
  81                         /// The call failed because resources (such as a priority level) were already being used by another caller.\r
  82                         /// </summary>\r
  83                         /// <remarks>This is a failed result.</remarks>\r
  84                         /// <unmanaged href="bb219706">DSERR_ALLOCATED</unmanaged>\r
  85                         property static Result Allocated\r
  86                         {\r
  87                                 Result get();\r
  88                         }\r
  89 \r
  90                         /// <summary>\r
  91                         /// This object is already initialized.\r
  92                         /// </summary>\r
  93                         /// <remarks>This is a failed result.</remarks>\r
  94                         /// <unmanaged href="bb219706">DSERR_ALREADYINITIALIZED</unmanaged>\r
  95                         property static Result AlreadyInitialized\r
  96                         {\r
  97                                 Result get();\r
  98                         }\r
  99 \r
 100                         /// <summary>\r
 101                         /// The specified WAVE format is not supported.\r
 102                         /// </summary>\r
 103                         /// <remarks>This is a failed result.</remarks>\r
 104                         /// <unmanaged href="bb219706">DSERR_BADFORMAT</unmanaged>\r
 105                         property static Result BadFormat\r
 106                         {\r
 107                                 Result get();\r
 108                         }\r
 109 \r
 110                         /// <summary>\r
 111                         /// The GUID specified in an audiopath file does not match a valid MIXIN buffer.\r
 112                         /// </summary>\r
 113                         /// <remarks>This is a failed result.</remarks>\r
 114                         /// <unmanaged href="bb219706">DSERR_BADSENDBUFFERGUID</unmanaged>\r
 115                         property static Result BadSendBufferGuid\r
 116                         {\r
 117                                 Result get();\r
 118                         }\r
 119 \r
 120                         /// <summary>\r
 121                         /// The buffer memory has been lost, and must be restored.\r
 122                         /// </summary>\r
 123                         /// <remarks>This is a failed result.</remarks>\r
 124                         /// <unmanaged href="bb219706">DSERR_BUFFERLOST</unmanaged>\r
 125                         property static Result BufferLost\r
 126                         {\r
 127                                 Result get();\r
 128                         }\r
 129 \r
 130                         /// <summary>\r
 131                         /// Tried to create a <see cref="BufferFlags">ControlEffects</see> buffer shorter than DSBSIZE_FX_MIN milliseconds.\r
 132                         /// </summary>\r
 133                         /// <remarks>This is a failed result.</remarks>\r
 134                         /// <unmanaged href="bb219706">DSERR_BUFFERTOOSMALL</unmanaged>\r
 135                         property static Result BufferTooSmall\r
 136                         {\r
 137                                 Result get();\r
 138                         }\r
 139 \r
 140                         /// <summary>\r
 141                         /// The control (vol, pan, etc.) requested by the caller is not available.\r
 142                         /// </summary>\r
 143                         /// <remarks>This is a failed result.</remarks>\r
 144                         /// <unmanaged href="bb219706">DSERR_CONTROLUNAVAIL</unmanaged>\r
 145                         property static Result ControlUnavailable\r
 146                         {\r
 147                                 Result get();\r
 148                         }\r
 149 \r
 150                         /// <summary>\r
 151                         /// Attempt to use DirectSound 8 functionality on an older DirectSound object.\r
 152                         /// </summary>\r
 153                         /// <remarks>This is a failed result.</remarks>\r
 154                         /// <unmanaged href="bb219706">DSERR_DS8_REQUIRED</unmanaged>\r
 155                         property static Result DirectSound8Required\r
 156                         {\r
 157                                 Result get();\r
 158                         }\r
 159 \r
 160                         /// <summary>\r
 161                         /// The effects requested could not be found on the system, or they were found\r
 162                         /// but in the wrong order, or in the wrong hardware/software locations.\r
 163                         /// </summary>\r
 164                         /// <remarks>This is a failed result.</remarks>\r
 165                         /// <unmanaged href="bb219706"></unmanaged>\r
 166                         property static Result EffectsUnavailable\r
 167                         {\r
 168                                 Result get();\r
 169                         };\r
 170 \r
 171                         /// <summary>\r
 172                         /// An undetermined error occurred inside the DirectSound subsystem.\r
 173                         /// </summary>\r
 174                         /// <remarks>This is a failed result.</remarks>\r
 175                         /// <unmanaged href="bb219706">DSERR_GENERIC</unmanaged>\r
 176                         property static Result Generic\r
 177                         {\r
 178                                 Result get();\r
 179                         }\r
 180 \r
 181                         /// <summary>\r
 182                         /// This call is not valid for the current state of this object.\r
 183                         /// </summary>\r
 184                         /// <remarks>This is a failed result.</remarks>\r
 185                         /// <unmanaged href="bb219706">DSERR_INVALIDCALL</unmanaged>\r
 186                         property static Result InvalidCall\r
 187                         {\r
 188                                 Result get();\r
 189                         }\r
 190 \r
 191                         /// <summary>\r
 192                         ///An invalid parameter was passed to the returning function.\r
 193                         /// </summary>\r
 194                         /// <remarks>This is a failed result.</remarks>\r
 195                         /// <unmanaged href="bb219706">DSERR_INVALIDPARAM</unmanaged>\r
 196                         property static Result InvalidParameter\r
 197                         {\r
 198                                 Result get();\r
 199                         }\r
 200 \r
 201                         /// <summary>\r
 202                         /// This object does not support aggregation.\r
 203                         /// </summary>\r
 204                         /// <remarks>This is a failed result.</remarks>\r
 205                         /// <unmanaged href="bb219706">DSERR_NOAGGREGATION</unmanaged>\r
 206                         property static Result NoAggregation\r
 207                         {\r
 208                                 Result get();\r
 209                         }\r
 210 \r
 211                         /// <summary>\r
 212                         /// No sound driver is available for use.\r
 213                         /// </summary>\r
 214                         /// <remarks>This is a failed result.</remarks>\r
 215                         /// <unmanaged href="bb219706">DSERR_NODRIVER</unmanaged>\r
 216                         property static Result NoDriver\r
 217                         {\r
 218                                 Result get();\r
 219                         }\r
 220 \r
 221                         /// <summary>\r
 222                         /// The requested COM interface is not available.\r
 223                         /// </summary>\r
 224                         /// <remarks>This is a failed result.</remarks>\r
 225                         /// <unmanaged href="bb219706">DSERR_NOINTERFACE</unmanaged>\r
 226                         property static Result NoInterface\r
 227                         {\r
 228                                 Result get();\r
 229                         }\r
 230 \r
 231                         /// <summary>\r
 232                         /// The object requested was not found.\r
 233                         /// </summary>\r
 234                         /// <remarks>This is a failed result.</remarks>\r
 235                         /// <unmanaged href="bb219706">DSERR_OBJECTNOTFOUND</unmanaged>\r
 236                         property static Result ObjectNotFound\r
 237                         {\r
 238                                 Result get();\r
 239                         }\r
 240 \r
 241                         /// <summary>\r
 242                         /// Another app has a higher priority level, preventing this call from succeeding.\r
 243                         /// </summary>\r
 244                         /// <remarks>This is a failed result.</remarks>\r
 245                         /// <unmanaged href="bb219706">DSERR_OTHERAPPHASPRIO</unmanaged>\r
 246                         property static Result OtherApplicationHasPriority\r
 247                         {\r
 248                                 Result get();\r
 249                         }\r
 250 \r
 251                         /// <summary>\r
 252                         /// The caller does not have the priority level required for the function to succeed\r
 253                         /// </summary>\r
 254                         /// <remarks>This is a failed result.</remarks>\r
 255                         /// <unmanaged href="bb219706">DSERR_PRIOLEVELNEEDED</unmanaged>\r
 256                         property static Result PriorityLevelNeeded\r
 257                         {\r
 258                                 Result get();\r
 259                         }\r
 260 \r
 261                         /// <summary>\r
 262                         /// A circular loop of send effects was detected.\r
 263                         /// </summary>\r
 264                         /// <remarks>This is a failed result.</remarks>\r
 265                         /// <unmanaged href="bb219706">DSERR_SENDLOOP</unmanaged>\r
 266                         property static Result SendLoop\r
 267                         {\r
 268                                 Result get();\r
 269                         }\r
 270 \r
 271                         /// <summary>\r
 272                         /// This object has not been initialized.\r
 273                         /// </summary>\r
 274                         /// <remarks>This is a failed result.</remarks>\r
 275                         /// <unmanaged href="bb219706">DSERR_UNINITIALIZED</unmanaged>\r
 276                         property static Result Uninitialized\r
 277                         {\r
 278                                 Result get();\r
 279                         }\r
 280 \r
 281                         /// <summary>\r
 282                         /// The function called is not supported at this time.\r
 283                         /// </summary>\r
 284                         /// <remarks>This is a failed result.</remarks>\r
 285                         /// <unmanaged href="bb219706">DSERR_UNSUPPORTED</unmanaged>\r
 286                         property static Result Unsupported\r
 287                         {\r
 288                                 Result get();\r
 289                         }\r
 290                 };\r
 291         }\r
 292 }